Get reply suggestions

GET https://connect.suryojasvi.com/api/v1/messages/reply_suggestions

Three short replies, suggested by the AI model the server uses for topic summaries, that the user could send next in a conversation, from its most recent messages. Available to the users who may use AI summaries, and counted against their monthly allowance for AI features.

Changes: New in Zulip 13.0 (feature level ZF-592235).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX GET -G https://connect.suryojasvi.com/api/v1/messages/reply_suggestions \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'narrow=[{"operand": "Denmark", "operator": "channel"}]'

Parameters

narrow (object)[] required

Example: [{"operator": "channel", "operand": "Denmark"}]

The conversation, as a narrow.

narrow object details:

  • operator: string required
  • operand: string | integer | (integer)[] required

    This parameter must be one of the following:

  • negated: boolean optional

Response

Return values

  • suggestions: (string)[]

    Up to three suggested replies.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "suggestions": [
        "Sounds good!",
        "I'll take a look.",
        "Thanks!"
    ]
}