v13

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

Retrieve Documents

Retrieve relevant documents.

request.filters supports equality checks (including scalar-to-array matches) and the same operator set as /retrieve/chunks: logical composition via $and, $or, $nor, $not, plus field predicates $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex, and $contains. Use the same JSON structure as /retrieve/chunks when expressing complex logic. Comparison operators require metadata typed as number, decimal, datetime, or date.

post/retrieve/docs

Headers

authorizationstring nullable

Request body

querystring nullable

Natural-language query used to retrieve relevant chunks or documents.

query_imagestring nullable

Base64-encoded image to use as query for Morphik multimodal retrieval. Requires use_colpali=True. Mutually exclusive with 'query'.

filtersobject nullable

Metadata filters supporting logical operators ($and/$or/$not/$nor) and field predicates ($eq/$ne/$gt/$gte/$lt/$lte/$in/$nin/$exists/$type/$regex/$contains).

kinteger

Maximum number of chunks or documents to return.

min_scorenumber

Minimum similarity score a result must meet before it is returned.

use_rerankingboolean nullable

When provided, overrides the workspace reranking configuration for this request.

use_colpaliboolean nullable

When provided, uses Morphik's finetuned ColPali style embeddings (recommended to be True for high quality retrieval).

output_format'base64' | 'url' | 'text'

Output format for image chunks in retrieval results.

paddinginteger

Number of additional chunks/pages to retrieve before and after matched chunks (ColPali only)

folder_depthinteger nullable

Folder scope depth. 0 or None = exact folder only, -1 = include all descendants, n > 0 = include descendants up to n levels deeper.

end_user_idstring nullable

Optional end-user scope for the operation

Response

Successful Response

scorenumber required

document_idstring required

metadataobject required

additional_metadataobject required