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_batch': The batch of document changes proposed for review, delivered as one event carrying changes[] (emitted when approval_mode is 'ask_every_time'). Changes are always delivered as a batch via this event.
- 'document_sync': Chunk-id sync emitted before the agent runs, so changes can reference stable ids.
- 'continue_prompt': A pause on a large edit, asking whether to continue or stop.
- 'documents_changed': Signals that one or more documents were auto-applied (with per-document change counts and changed chunk ids).
- 'model_fallback': Notice that the request automatically failed over to another model tier.
- '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).
Request
- Base URL: https://api.superdocs.app
- URL: https://api.superdocs.app/v1/chat/{session_id}/stream
- Auth: none declared
Path parameters
Query parameters
Job ID to stream progress for
SSE Last-Event-ID resume: only replay intermediate responses with sequence > this. Reconnects pass the highest sequence already processed so old events are NOT re-emitted; default 0 = full history.
Authentication token (query parameter for EventSource compatibility)
API key (query parameter for EventSource compatibility)
Headers
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.