Stream Chat Progress

Stream real-time progress for a chat job using Server-Sent Events (SSE).

Opens an SSE connection that streams events as the AI processes your request. Use this with the job_id returned from POST /v1/chat/async.

Event types:

‘intermediate’: Progress updates during processing (content, sequence, timestamp).
‘proposed_change’: A document change proposed for review (when approval_mode is ‘ask_every_time’).
‘final’: Processing complete. Contains the full result with AI response and document changes.
‘usage’: Billing data emitted after ‘final’ (monthly_used, monthly_limit, monthly_remaining).
‘error’: An error occurred (job failed, cancelled, or not found).

Authentication: Pass a token or api_key as a query parameter (required for EventSource which cannot set headers).

GET

chat

{session_id}

stream

Stream Chat Progress

curl --request GET \
  --url https://api.superdocs.app/v1/chat/{session_id}/stream

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

authorization

string | null

session_id

string

required

job_id

string

required

Job ID to stream progress for

token

string

Authentication token (query parameter for EventSource compatibility)

api_key

string

API key (query parameter for EventSource compatibility)

Successful Response

⌘I

Stream Chat Progress

curl --request GET \
  --url https://api.superdocs.app/v1/chat/{session_id}/stream

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}