ONonyx-dot-app
public

Handle Send Chat Message

Changed on

This endpoint is used to send a new chat message.

Args: chat_message_req (SendMessageRequest): Details about the new chat message. - When stream=True (default): Returns StreamingResponse with SSE - When stream=False: Returns ChatFullResponse with complete data request (Request): The current HTTP request context. user (User): The current user, obtained via dependency injection. _ (None): Rate limit check is run if user/group/global rate limits are enabled.

Returns: StreamingResponse | ChatFullResponse: Either streams or returns complete response.

post/chat/send-chat-message

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/chat/send-chat-message
  • Auth
    HTTP bearer

Request body

messagestring required
allowed_tool_idsinteger[] nullable
forced_tool_idinteger nullable
deep_researchboolean
mcp_headersobject nullable

Headers forwarded to MCP tool calls made while answering this message, e.g. {"Authorization": "Bearer <user_jwt>", "X-User-ID": "user123"}. Use this to pass end-user credentials through to MCP servers that require them.

origin'webapp' | 'chrome_extension' | 'api' | 'slackbot' | 'widget' | 'discordbot' | 'mobile' | 'unknown' | 'unset'

Origin of a chat message for telemetry tracking.

parent_message_idinteger nullable
chat_session_idstring uuid nullable
streamboolean
include_citationsboolean
additional_contextstring nullable

A string of extra context injected into the LLM call for this request. The context is passed to the model but is not stored in the database and will not appear in the chat history. Use this to supply ephemeral, request-scoped information (e.g. the user's current page URL, session metadata, or any runtime context) without polluting the persistent conversation history. Pass null or omit the field to use no additional context.

Response

If stream=true, returns text/event-stream. If stream=false, returns application/json (ChatFullResponse).

answerstring required
answer_citationlessstring required
pre_answer_reasoningstring nullable
message_idinteger required
chat_session_idstring uuid nullable
incognitoboolean
error_msgstring nullable

Changes

  • fcb09658bc37Revision changes
    • breaking

      removed the enum value csv of the request property //

    • breaking

      removed the enum value requesttracker of the request property ////

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new box enum value to the request property ////

    • info

      added the new braintrust enum value to the request property ////

    • info

      added the new canvas enum value to the request property ////

    • info

      added the new craft_file enum value to the request property ////

    • info

      added the new discordbot enum value to the request property

    • info

      added the new lumapps enum value to the request property ////

    • info

      added the new mobile enum value to the request property

    • info

      added the new tabular enum value to the request property //

    • info

      added the media type text/event-stream for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8230a6a0119aRevision changes
    • info

      added the new optional request property