Sign in
Documents

List Documents

List accessible documents with metadata filtering.

Supported operators: $and, $or, $nor, $not, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex, $contains.

Implicit equality (backwards compatible):

{"status": "active"}

Uses JSONB containment, matches scalars inside arrays, JSON-serializable types only.

Explicit operators (typed comparisons):

{"priority": {"$eq": 42}, "created_date": {"$gte": "2024-01-01T00:00:00Z"}}

Supports typed metadata (number, decimal, datetime, date) with safe casting.

post/documents

Query parameters

string
OR
string[]
folder_depthinteger nullable

Folder scope depth: 0/None = exact, -1 = all descendants, n > 0 = include descendants up to n levels.

Folder scope depth: 0/None = exact, -1 = all descendants, n > 0 = include descendants up to n levels.

end_user_idstring nullable

Headers

authorizationstring

Request body

document_filtersobject nullable

Metadata filters with operator support: $and, $or, $nor, $not, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex, $contains. Implicit equality uses JSONB containment; explicit operators support typed comparisons.

skipinteger

Number of documents to skip before returning results.

limitinteger

Maximum number of documents to return.

Response

Successful Response

external_idstring
content_typestring required
filenamestring nullable
metadataobject
metadata_typesobject
storage_infoobject
system_metadataobject
additional_metadataobject
chunk_idsstring[]
summary_storage_keystring nullable
summary_versioninteger nullable
summary_bucketstring nullable
summary_updated_atstring nullable
folder_namestring nullable
end_user_idstring nullable
app_idstring nullable
folder_pathstring nullable
folder_idstring nullable

Changes