Sign in
parsing

Cancel a parsing job

Cancel a specific parse job.

Args: job_id: The ID of the parse job to cancel.

Returns: The cancelled parsing job.

patch/v1/parsing/jobs/{job_id}

Path parameters

job_idstring uuid required

The ID of the parse job to cancel

The ID of the parse job to cancel

Response

The cancelled parse job

idstring required

The ID of the job

file_idstring required

The ID of the file to parse

filenamestring nullable

The name of the file

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

The error of the job

started_atstring date-time nullable

The started time of the job

finished_atstring date-time nullable

The finished time of the job

created_atstring date-time

The creation time of the job

updated_atstring date-time nullable

The updated time of the job

object'parsing_job'

The type of the object

Changes