Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1391215649.1 KB

64bfe76b130e

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.

AG-UI is the sole wire protocol. The vocabulary is described by ConversationMessageStreamSSEEvent; it is the same event set as /conversations/stream, while the terminal result reflects an existing conversation.

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'agent' | 'internal_search' | 'web_search' required

Optional execution mode for non-stream consumers of this shared request schema.

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.

protocol'agui'

AG-UI is the only supported wire protocol. When present must be "agui". Omitting the field is equivalent — the server always uses the AG-UI vocabulary (see ConversationMessageStreamSSEEvent). Kept in the schema for backward compatibility with callers that already send it.

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.