Streaming

Stream structured JSON objects via SSE

Streams partial JSON objects as they're generated using Server-Sent Events (SSE). Provides real-time streaming of structured data with partial object parsing. Event types: session (session ID), partial-object (partial JSON with parsed object), object (final validated object), result (final usage stats), error (errors), done (stream complete).

post/stream-object

Request body

systemstring

promptstring required

sessionIdstring

modelstring

allowedToolsstring[]

Response

SSE stream with real-time partial JSON objects

Changes

Changed in 4 of the 7 revisions of this API.122

Jul 17, 2026f7074f1efbee11See the full diff
- ●
  added the new NO_TOOLS_AVAILABLE enum value to the code response property for the response status 400
  response-property-enum-value-added
- ○
  added the new optional request property allowedTools
  new-optional-request-property
Dec 27, 2025b62b4ac2e1b71See the full diff
- ●
  removed the request property userEmail
  request-property-removed
Dec 27, 20253575d0f3e4161See the full diff
- ○
  endpoint added
  endpoint-added
Dec 24, 202562c4085e0ca01See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history