Skip to main content
GET
Retrieve an extraction job (poll for status)

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Path Parameters

extraction_id
string
required

Query Parameters

wait
integer
default:0

Seconds to hold the request open waiting for the job to reach a terminal state (long polling). 0 (the default) returns the current state immediately.

The response returns as soon as the job completes or fails, so a short job costs one request instead of a sleep loop. If the budget runs out first the request still returns 200 with the job's current state — a still-running job is not an error. Check status and call again.

Capped at 45 seconds, below the 60-second request timeout.

Required range: 0 <= x <= 45

Response

Current job state; includes billing and, when complete, a pointer to the result.

id
string
required
Example:

"ext_01J9ZJYA"

object
string
required
Allowed value: "extraction"
status
enum<string>
required
Available options:
processing,
completed,
failed
documents
object[]
required
sandbox
boolean
required
created_at
string<date-time>
required
billed_total_usd
string
Example:

"12.00"

completed_at
string<date-time>
elapsed_seconds
integer

Whole seconds since created_at. Present while processing, so a caller can tell a job that just started from one approaching the 60-minute ceiling without doing date math.

Example:

42

poll_after_seconds
integer

Recommended seconds to wait before polling again. Present while processing; mirrors the Retry-After header. Prefer this over a hard-coded interval.

Example:

15

result_url
string

Convenience link to /v1/extractions/{id}/result; present when completed.