Skip to main content
POST
HTTP 200 can contain a pending job. Check status and poll with task: "extract". Ready stems start muted. Extract and separate.

Headers and parameters

Paid requests accept USDC session or Credits headers. Use the selected account consistently in headers and creator fields.
string
For USDC: Bearer followed by the complete issued session token.
For Credits, send x-wallet-auth-token and x-credit-source (card or promo). A stable x-idempotency-key of at most 80 characters identifies a paid service operation.
string
required
Selected account address. Required for owner-scoped reads and writes. It identifies the account; your product must authenticate its own users.
string
Session network in CAIP-2 form, for example eip155:8453.

JSON body

string
required
Opaque ID returned by the API. Minimum length: 1.
string
required
Wallet address for the selected account. Use the same address as the session owner. Minimum length: 10.
string
Optional source override, for example the url from Upload source. Use an HTTP(S) URL.
string
default:"all"
Use a stem ID from GET /api/options. Omitted value is all.

Response (200)

Success.
string
required
Values: pending, processing, ready, error.
number
string
object | null
string
string[]
object[]
string
Candidate state. Initially pending; later reads can report merged or discarded. Values: pending, merged, discarded.
string
required
string
required
string
required
Values: extract.
Budget headers use six-decimal USDC atomic units. See session payments.

Errors

Failed JSON responses contain an error string. Check the HTTP status before reading a successful result. See job handling for interrupted or uncertain submissions.