Sign in
AI Gateway

Explicit SSE contract for generated clients; never buffers a successful event stream.

Changed on
post/ai/v1/responses/stream

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ai/v1/responses/stream
  • Auth: HTTP bearer

Request body

backgroundboolean nullable

Run asynchronously and poll for the result. Requires your own provider key: the result is fetched from the provider account.

conversationobject nullable

Attach the response to a stored conversation. Requires your own provider key, for the same reason as previous_response_id.

modelstring required

Model to run, e.g. gpt-6-luna. Must be served by OpenAI.

previous_response_idstring nullable

Continue from a stored response. Requires your own provider key (X-Provider-Api-Key), because stored responses live in the provider account that created them.

streamboolean

Stream the reply as server-sent events.

Response

Incremental Responses events; forces stream=true

Changes