Poll Job
Check the status and retrieve results of an asynchronous job
(submitted via any endpoint with async: true).
Overview
Check the status and retrieve results of an asynchronous job (e.g., submitted via/extract with async: true).
Poll this endpoint periodically until the job reaches a terminal state (completed, failed, canceled, or expired).
Response
The response includes job metadata and, when completed, the full extraction results.Response Fields
| Field | Type | Description |
|---|---|---|
job_id | string | Unique identifier for the extraction job. |
status | string | Current job status: pending, processing, completed, failed, canceled, or expired. |
created_at | string | ISO 8601 timestamp when the job was submitted. |
updated_at | string | ISO 8601 timestamp of the last status update. |
result | object | Job output. Present when status is completed, and on expired as a retention stub. Large outputs return a { is_url, url } pointer instead of inline data (see Large Results). See Extract for result structure. |
error | string | Error message (only present when status is failed). |
Job Status Values
| Status | Description |
|---|---|
pending | Job is queued and waiting to be processed. |
processing | Job is currently being processed. |
completed | Job finished successfully. Results are available in the result field. |
failed | Job encountered an error. See error field for details. |
canceled | Job was canceled before completion. |
expired | Job’s retention window has passed and its stored output was purged. Run a new extraction to regenerate it. |
Large Results (is_url)
When the output is large (at or above 5 MB), result is replaced with a pointer instead of inline data. Fetch url to download the full result JSON.
| Field | Type | Description |
|---|---|---|
is_url | boolean | true when result is a pointer rather than inline data. |
url | string | Location of the full result JSON (presigned S3 URL or Pulse proxy URL). |
Polling Strategy
We recommend polling with exponential backoff:Example Usage
Check Job Status
Complete Async Workflow
Authorizations
API key for authentication
Path Parameters
Identifier returned from an async job submission.
Response
Current job status payload
Current status and metadata for an asynchronous job.
Identifier assigned to the asynchronous job.
Lifecycle status for an asynchronous job.
pending, processing, completed, failed, canceled, expired Timestamp when the job was accepted.
Timestamp of the last status update, if available.
Job output. Present when completed, and on expired as a retention stub. Large outputs return a { is_url, url } pointer (see LargeResultStub) instead of inline data.
- Option 1
- Option 2
Error message describing why the job failed, if applicable.
