Sign in

v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
files_v2

get/documents/v2/files

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'

Direction of pagination.

This can be either next or prev.

next means to get the next page of results, while prev means to get the previous page of results.

limitinteger

Optional limit for the number of results to return.

This is a positive integer that specifies the maximum number of results to return. If not provided, a default value will be used.

file_namestring nullable

Optional file name to filter results by.

This is a case-sensitive substring that will be matched against the file names.

If provided, only files with names containing this substring will be returned.

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.

Response

List of files

has_moreboolean required
next_cursorstring nullable
prev_cursorstring nullable

Example response

{
  "items": [
    {
      "file_id": "file_12345",
      "file_name": "example.pdf",
      "file_size": 100000,
      "checksum_sha256": "d3242c5c1d369d233fa65183bdd4c486eba109ceb13490ed291384eaffbe743b",
      "created_at": "2023-10-01T12:00:00Z",
      "labels": {
        "priority": "high",
        "source": "email"
      }
    }
  ]
}