DocumentationJobs API

Jobs API

Reference for async job endpoints.

POST/v1/jobs

Create job

Queue a capture request for async processing.

GET/v1/jobs/{id}

Get job status

Returns job status, timestamps, and progress.

GET/v1/jobs/{id}/result

Get job result

Returns the completed capture payload.

DELETE/v1/jobs/{id}

Cancel job

Cancels a queued job before it starts.

Create job

{
  "url": "https://example.com",
  "format": "png",
  "webhook": {
    "url": "https://example.com/webhooks/capture",
    "sign": true,
    "errors": true
  }
}
{
  "result": {
    "job_id": "123",
    "status": "queued",
    "status_url": "/v1/jobs/123"
  }
}

Status values

queued, running, complete, error.

Notes

  • Async jobs only support response_type: "json".
  • Use idempotency keys for safe retries.
Updated 1 day ago
Did this page help you?