GET
Get a job
This is the one poll endpoint for every async v2 operation, told apart by kind. See The async job lifecycle for the agent job’s status values, its result and error shapes, and the SUPERAGENT_RUN_STALE provisional-failure case.

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

job_id
string
required

Response

The job.

job_id
string
required
kind
enum<string>
required

Discriminator. extraction for a document job; agent for a question asked of the agent, which reports different statuses and a different result.

Available options:
extraction
Example:

"extraction"

status
enum<string>
required
Available options:
queued,
succeeded,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
client_ref
string | null

Echo of the submitted client_ref.

result
object | null

Present only when status is succeeded.

error
object | null

Present only when status is failed.

usage
object | null

Present once the job has settled.