GET/messages/{message_id}/suggested

Get Next Suggested Questions

Available for: Chatflow, Agent, Chatbot, Legacy Agent apps.

Returns the follow-up questions suggested for a message.

2 parameters
message_idstringrequired
ID of the message to get suggestions for. Get it from a chat response or [List Conversation Messages](/en/api-reference/conversations/list-conversation-messages).
userstringrequired
End-user identifier, defined by your app and unique within it. See [End User Identity](/en/api-reference/guides/end-user-identity).

4 status codes
200Successfully retrieved suggested questions.
dataarray<string>optional
List of suggested questions.
resultstringoptional
Result status.
400- `not_chat_app` : App mode does not match the API route. - `bad_request` : Suggested questions feature is disabled.

2 documented failures

  • bad_request

    Suggested Questions Is Disabled.

    bad_request

  • not_chat_app

    Please check if your app mode matches the right API route.

    not_chat_app

404`not_found` : Message does not exist.

One documented failure

  • not_found

    Message Not Exists.

    not_found

500`internal_server_error` : Internal server error.

One documented failure

  • internal_server_error

    The server encountered an internal error and was unable to complete your request. Either the server is overloaded or there is an error in the application.

    internal_server_error

Error handling

A 400 is returned: - not_chat_app : App mode does not match the API route.

  • bad_request : Suggested questions feature is disabled. A 404 is returned: not_found : Message does not exist. A 500 is returned: internal_server_error : Internal server error.