Sign in

v1

latestOpenAPI 3.1.02026-07-222064110.7 KB
Extract

ADE Get Extract Jobs

Get the status of an async Extract job, including its result once the job has completed.

get/v2/extract/jobs/{job_id}

Path parameters

job_idstring required

The identifier of the job to retrieve, as returned by the create-job request.

The identifier of the job to retrieve, as returned by the create-job request.

Response

Job status / result

job_idstring

The unique identifier for this v2-extract job. Format: extract-<26-character Crockford base32 ULID> ([0-9a-hjkmnp-tv-z]{26} tail). Opaque, server-minted, and stable for the life of the job — the same id is returned on the sync response, the async 202, and every poll. Treat it as opaque; older id formats remain accepted indefinitely and are never re-issued.

status'pending' | 'processing' | 'completed' | 'failed'
created_atstring nullable
completed_atstring

Present once the job is terminal.

progressnumber

Job completion as a decimal from 0 (not started) to 1 (complete). Present while processing.

output_urlstring nullable

The URL the result was delivered to. Present once the job has completed and output_save_url was set, instead of inline result.