API reference · Jobs
Server-sent progress events for a job
GET /api/v1/jobs/{job_id}/stream
An SSE stream of progress events, ending when the job completes or fails. Steps are preprocess, chunk:N and aggregation, each reporting completed out of total. Rate limit: 120 requests per minute.
Progress is best effort: when the stream pool is saturated the connection is still accepted and sends waiting heartbeats with an ETA rather than refusing.
Authenticate with your key in the X-API-Key header — Authentication.
Path parameters
- job_id string (uuid) required
Responses
- 200 An event stream.
- 401 Missing, malformed or revoked API key.
- 404 No such job for this account.
- 429 Too many requests for this endpoint. Back off and retry; the official SDKs do this for you.
Related endpoints
- List recent jobs, newest first GET /api/v1/jobs
- Retrieve one job GET /api/v1/jobs/{job_id}
- Cancel a job POST /api/v1/jobs/cancel
- Check many jobs for failure in one call POST /api/v1/jobs/check-failed