NAnace
Documents

Get a document job

The job with its result once it has finished. Readable at any balance. Links to the job's artifacts point at /v1/documents/jobs/{id}/... and need the same API key.

get/v1/documents/jobs/{id}

Request

Path parameters

idstring uuid required

The job's job_id, as returned when it was created.

Response

The job.

job_idstring uuid required
kind'parse' | 'split' | 'classify' | 'extract' | 'ground' required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
resultunknown
creditsinteger nullable

Credits the job used; final once usage_final is true. Drex charges the job's final billable usage once, at the USD price pinned when it was admitted (see Models & pricing). credits is the document service's usage count, not a multiplier for the per-page or per-target price. A failed job is never charged, including when it produced partial results. A job cancelled before completion is not charged, including delivered parts.

usage_finalboolean

Changes

No recorded changes to this operation across all 1 revision of this API.