Skip to navigation

Stream the reply

Server-sent events: sources, delta (text), tool_call, tool_result, message (the whole reply), done, error. Each reply is a model call, metered as chat tokens.

Needs the chat:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The conversation id.

Response

A server-sent event stream of reply frames; it ends after done or error.

sourcesobject
How many knowledge passages ground the reply, and which documents they came from.
OR
deltaobject
The next piece of the reply's text.
OR
tool_callobject
A tool the expert decided to call, sent before it runs.
OR
tool_resultobject
The outcome of a tool call.
OR
messageobject

The whole reply, as stored. A done frame follows.

OR
doneobject
The reply is complete.
OR
errorobject
The reply failed.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error