API reference · Jobs
Cancel a job
POST /api/v1/jobs/cancel
Rate limit: 30 requests per minute.
Authenticate with your key in the X-API-Key header — Authentication.
Request body
Required. application/json
- job_id string (uuid) required
Responses
- 200 Accepted.
- 401 Missing, malformed or revoked API key.
- 404 No such job for this account.
- 422 A field is missing or the wrong type. The body names the offending field.
- 429 Too many requests for this endpoint. Back off and retry; the official SDKs do this for you.
200 response fields
- status string required
Related endpoints
- List recent jobs, newest first GET /api/v1/jobs
- Retrieve one job GET /api/v1/jobs/{job_id}
- Server-sent progress events for a job GET /api/v1/jobs/{job_id}/stream
- Check many jobs for failure in one call POST /api/v1/jobs/check-failed