Skip to main content
POST
List Documents

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string | null

Body

application/json
document_ids
integer[] | null

Specific document IDs to retrieve. When provided, ignores metadata_filter and latest_only parameters.

metadata_filter
Metadata Filter · object | null

Metadata filters using MongoDB-like query syntax. Supports comparison, array, and logical operators

created_at_filter
Created At Filter · object | null

Filter by created_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')

updated_at_filter
Updated At Filter · object | null

Filter by updated_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')

offset
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
sort_field
enum<string>
default:last_created_at

Field to sort by

Available options:
first_created_at,
last_created_at
sort_order
enum<string>
default:desc

Sort order (ascending or descending)

Available options:
asc,
desc
latest_only
boolean
default:true

If True, returns only the latest version of each document

Response

Successful Response

data
DocumentListData · object
required

Response data

success
boolean
default:true
error
ErrorDetail · object | null

Schema for API error responses.

Example:
meta
MetaData · object

Metadata for API responses