v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB

Conversations

Add message to a conversation with streaming response

Add a follow-up message to an existing conversation and stream the assistant's response over Server-Sent Events.

Functionally equivalent to POST /conversations/{conversationId}/messages but the response is delivered as an SSE stream so clients can render the answer incrementally.

The wire vocabulary is described by AssistantMessageStreamSSEEvent. It is the same event set as /conversations/stream; only the connected and complete payloads differ because the conversation already exists when this route is called.

post/conversations/{conversationId}/messages/stream

Path parameters

conversationIdstring objectId required

Identifier of the conversation to append the message to. The conversation must belong to the caller and must not be deleted.

Request body

querystring required

The follow-up question or message content

modelKeystring

Override the model for this specific message

modelNamestring

Display name of the model

modelFriendlyNamestring

Friendly display name of the model

chatMode'web_search' | 'internal_search'

Chat mode for this message

timezonestring

IANA timezone identifier from the client (top-level field). Used to provide time-aware context to the AI.

currentTimestring date-time

ISO 8601 / RFC 3339 datetime from the client (top-level field; UTC Z or numeric offset).

toolsstring[]

Optional list of tool identifiers the agent may invoke for this follow-up message. Semantics are identical to the create-conversation tools field.

Example request

{
  "query": "Can you elaborate on the revenue trends?",
  "timezone": "America/New_York",
  "currentTime": "2026-04-12T16:00:00+05:30",
  "tools": [
    "jira.create_issue",
    "confluence.search_content"
  ]
}

Response

SSE stream established. The body is a sequence of text/event-stream frames using the event vocabulary described on the schema below.