SSE streaming

Responses API-Compatible Integration Guide

Send a small request to /v1/responses, consume typed SSE events as they arrive, and keep endpoint compatibility distinct from full OpenAI API parity.

Minimal streaming request

JSON body
{
  "model": "returned-model-id",
  "input": "Reply with one short integration tip.",
  "stream": true
}

Authenticate with Authorization: Bearer $QUICKAICODE_API_KEY and request text/event-stream.

Common text-stream lifecycle events

response.created

The response lifecycle has started.

response.output_text.delta

Append the delta value to the visible output immediately.

response.completed

The response completed normally.

error

Stop the stream and surface the structured error safely.

Client behavior

  • Disable response buffering in intermediaries you control.
  • Parse complete SSE frames, not arbitrary TCP chunks.
  • Use separate connection and stream-idle timeouts.
  • Record request IDs and timestamps without logging credentials.

Tested scope

Endpoint compatibility is not feature parity

Support is limited to behavior, fields, and event types explicitly documented as tested. Hosted tools, response storage, background mode, WebSocket mode, remote MCP, and future API additions are not implied unless separately verified.