API reference · Jobs
Server-sent progress events for a job
GET /api/v1/jobs/{job_id}/stream
An SSE stream of progress events, ending with one terminal completed (data: {"download_url": ...}) or failed (data: {"step": ..., "reason": ...}) event. Steps are preprocess, chunk:N and aggregation. Each event reports completed out of total and is sent when a step finishes, so the first event has completed >= 1. Files under about 3 MiB skip preprocess and may send no progress event before completed. Each event has an id; send it back as Last-Event-ID when you reconnect. Rate limit: 120 requests per minute.
When the stream pool is saturated, the request returns 503. Poll GET /api/v1/jobs/{job_id} instead, or retry.
Send your API key in the X-API-Key header. See 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.
- 503 The stream pool is saturated. Retry, or poll the job instead.
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