Skip to main content
POST
Create an extraction job

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Headers

Idempotency-Key
string

Unique key making the request safely retryable.

Maximum string length: 255

Body

application/json

Provide exactly one of document_id or bundle.

document_id
string
required

Single document to extract.

bundle
object

Deal bundle (offering memorandum + rent roll + T-12), billed at the bundle rate. Size caps apply per component.

Response

Accepted and billed; processing started.

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>
result_url
string

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