v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
parse

get/documents/v2/parse

Query parameters

cursorstring

Optional cursor for pagination.

This is a base64-encoded string representing a timestamp. It is used to paginate through the results.

direction'next' | 'prev'

The direction of pagination.

This can be either next or prev.

The default is next, which means the next page of results will be

dataset_namestring nullable

The name of the dataset to filter the results by.

This is an optional parameter because not every parse operation is associated with a dataset.

limitinteger

The maximum number of results to return per page.

The default is 100.

filenamestring nullable

The filename to filter the results by.

This is an optional parameter that can be used to filter the results by the filename of the parsed document.

status'pending' | 'processing' | 'successful' | 'failure'

The status of the parse operation to filter the results by.

This is an optional parameter that can be used to filter the results by the status of the parse operation.

The possible values are pending, processing, failure, and successful.

idstring nullable

The ID of the parse operation to filter the results by.

created_afterstring nullable

The date and time after which the parse operation was created.

The date should be in RFC3339 format.

created_beforestring nullable

The date and time before which the parse operation was created.

The date should be in RFC3339 format.

finished_afterstring nullable

The date and time after which the parse operation was finished.

The date should be in RFC3339 format.

finished_beforestring nullable

The date and time before which the parse operation was finished.

The date should be in RFC3339 format.

include_configurationboolean

Response

List of parse jobs

has_moreboolean required
next_cursorstring nullable
prev_cursorstring nullable