Sign in
extractions

Start an extraction job

Start an extraction job for the provided file and schema.

Args: params: The parameters for creating an extraction job.

Returns: The created extraction job.

post/v1/extractions/jobs

Request body

file_idstring required

The ID of the file to extract from

json_schemaobject required

The JSON schema to use for extraction

Response

The created extraction job

idstring uuid required

Unique identifier for the extraction job

organization_idstring uuid required

ID of the organization that owns this job

file_idstring uuid required

ID of the file being extracted

created_atstring date-time required

When the job was created

updated_atstring date-time required

When the job was last updated

started_atstring date-time nullable required

When the job started processing

finished_atstring date-time nullable required

When the job finished processing

status'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed' required

The lifecycle of a unit of background work.

One vocabulary for every job family. The database keeps a separate enum type per table (parsing_job_status, store_file_status, ...) but they all carry these values, so the aliases below are this enum rather than copies of it. :class:SyncStatus is this set plus IDLE for connectors, which have a resting state between runs.

errorobject nullable required

Error information if failed

json_schemaobject required

The JSON schema used for extraction

Changes