Sign in

v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
datasets

get/documents/v2/datasets

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

status'idle' | 'processing'

The status dataset to filter the results by.

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

The possible values are processing and `idle``.

namestring nullable

The name of the dataset to filter the results by.

This is an optional parameter that can be used to filter the results by the name of the dataset.

Because dataset names are not unique, this will return all datasets that match the provided name.

Response

List of datasets retrieved successfully

has_moreboolean required
next_cursorstring nullable
prev_cursorstring nullable

Example response

{
  "items": [
    {
      "name": "Invoices Dataset",
      "dataset_id": "dataset_12345",
      "description": "This dataset contains invoices for the year 2023.",
      "created_at": "2023-10-01T12:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z"
    }
  ]
}