v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-226780228.2 KB

Search Documents By Name

Search documents by filename using full-text search.

request.filters accepts the same operator set as /retrieve/chunks: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex (with optional i flag), $contains, and the logical operators $and, $or, $nor, $not. Comparison clauses honor typed metadata (number, decimal, datetime, date).

post/search/documents

Headers

authorizationstring nullable

Request body

querystring required

Search query for document names/filenames

limitinteger

Number of documents to return

filtersobject nullable

Optional metadata filters for documents

folder_depthinteger nullable

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

end_user_idstring nullable

Optional end-user scope for the search

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