Sign in
parsing

Start a parse job

Start a parse job for the provided file.

Args: params: The parameters for creating a parse job.

Returns: The created parsing job.

post/v1/parsing/jobs

Request body

file_idstring required

The ID of the file to parse

element_typesElementType[] nullable

The elements to extract from the document

chunking_strategy'page'

Strategy used for chunking document content.

return_format'html' | 'markdown' | 'plain'

Format options for the returned document content.

mode'fast' | 'high_quality'

The mode of the document parser.

Response

The created 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

Changed in 1 of the 30 revisions of this API.2

  • 587cbdf607b02See the full diff
    • ○

      added to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed from the response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog