v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
datasets

get/documents/v2/datasets/{dataset_id}/data

Path parameters

dataset_idstring required

The id of the dataset to retrieve data for

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 returned.

limitinteger

The maximum number of results to return per page.

The default is 100.

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 running and `idle``.

parse_idstring nullable

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

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

Prefer using /documents/v2/parse/{parse_id} endpoint to get the details of a specific parse operation instead of filtering by parse_id.

file_namestring nullable

The name of the file to filter the results by.

This is an optional parameter that can be used to filter the results by the name of the file associated with the parse operation.

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.

Response

List of dataset jobs retrieved successfully

has_moreboolean required
next_cursorstring nullable
prev_cursorstring nullable