GET
/
api
/
v1
/
document-extractions
/
{workflowName}

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflowName
string
required

Query Parameters

​
status
enum<string>

Filter jobs by status

Available options:
pending,
pending_type_identified,
pending_type_unknown,
extraction_running,
extracted,
extracted_formatted,
extracted_formatted_and_validated,
failed
​
pdf_type
string

Filter jobs by PDF type

Response

200 - application/json
​
file_id
string

The unique identifier for the file

​
job_id
string | null

The unique identifier for the job

​
organizationId
string

The organization ID

​
status
enum<string>

The status of the job

Available options:
pending,
pending_type_identified,
pending_type_unknown,
extraction_running,
extracted,
extracted_formatted,
extracted_formatted_and_validated,
failed
​
createdAt
string

The creation timestamp

​
updatedAt
string

The last update timestamp

​
file_metadata
object | null

Metadata associated with the file

​
extraction
object | null

Extraction details

Upload and submit a document for extractionRetrieve a job by ID