Sign in

Changed on
post/api/v1beta/me/messages/submitstream

Request

  • The document declares no server URL.
  • Auth: bearer_auth (a scheme the document does not define)

Request body

assistant_idstring uuid

Optional assistant ID to associate with the chat when creating a new chat. If provided with an existing_chat_id, this field is ignored.

chat_provider_idstring

The ID of the chat provider to use for generation. If not provided, will use the highest priority model for the user.

delegation_run_mode'wait' | 'background'

How a delegated child run relates to the turn that spawned it: wait blocks the turn on the child and feeds the result back into it, background returns at launch and the child result never re-enters the turn.

disabled_mcp_server_idsstring[]

MCP servers a newly created chat starts with switched off; their tools are withheld from the model. Ignored when existing_chat_id is provided; PUT /me/chats/{chat_id} changes the list on an existing chat.

disabled_mcp_toolsstring[]

server/tool patterns of MCP tools a newly created chat starts with switched off; matching tools are withheld from the model. Ignored when existing_chat_id is provided; PUT /me/chats/{chat_id} changes the list on an existing chat.

existing_chat_idstring uuid nullable

The ID of an existing chat to use. If provided, the chat with this ID will be used instead of creating a new one. This is useful for scenarios where you have created a chat first (e.g. for file uploads) before sending the first message.

input_files_idsstring[]

The IDs of any files attached to this message. These files must already be uploaded to the file_uploads table. The files should normally only be provided with the first message they appear in the chat. After that they can assumed to be part of the chat history.

mcp_write_tools_enabledboolean

Whether a newly created chat offers the model MCP write tools and client actions. Defaults to enabled. Ignored when existing_chat_id is provided; PUT /me/chats/{chat_id} changes it on an existing chat.

mentioned_assistant_idsstring[]

Assistants the user @-mentioned in this message as delegation targets. Validated server-side; requires delegation.assistants.enabled.

previous_message_idstring uuid nullable

The ID of the message that this message is a response to. If this is the first message in the chat, this should be empty.

selected_facet_idsstring[]

IDs of facets selected by the user for this generation.

title_by_user_providedstring

Optional user-specified display name for a newly created chat. Ignored when existing_chat_id is provided.

user_messagestring required

The text of the message.

Example request

{
  "assistant_id": "00000000-0000-0000-0000-000000000000",
  "chat_provider_id": "primary",
  "existing_chat_id": "00000000-0000-0000-0000-000000000000",
  "previous_message_id": "00000000-0000-0000-0000-000000000000",
  "user_message": "Hello, world!"
}

Changes

  • a628ab508863Revision changes
    • breaking

      added subschema #2 subschema #4 to the response body oneOf list for the response status

    • info

      removed subschema #2 subschema #4 from the response body oneOf list for the response status

  • 4c1593b65b6bRevision changes
    • breaking

      added subschema #2 subschema #4 to the response body oneOf list for the response status

    • info

      removed subschema #2 subschema #4 from the response body oneOf list for the response status