API reference · Jobs
Retrieve one job
GET /api/v1/jobs/{job_id}
Poll this if you are not using the SSE stream. Rate limit: 120 requests per minute.
Authenticate with your key in the X-API-Key header — Authentication.
Path parameters
- job_id string (uuid) required
Responses
- 200 The job.
- 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.
200 response fields
- job_id string (uuid) required
- status string required
One of
processing,completed,failed - download_url string (uri) | null
Present once status is
completed. - failed_stage string | null
Which stage failed, when status is
failed. - reason string | null
Why it failed, when status is
failed.
Related endpoints
- List recent jobs, newest first GET /api/v1/jobs
- Server-sent progress events for a job GET /api/v1/jobs/{job_id}/stream
- Cancel a job POST /api/v1/jobs/cancel
- Check many jobs for failure in one call POST /api/v1/jobs/check-failed