v13

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

Retrieve Chunks

Retrieve relevant chunks.

The optional request.filters payload accepts equality checks (which also match scalars inside JSON arrays) plus the logical operators $and, $or, $nor, and $not. Field-level predicates include $eq, $ne, $in, $nin, $exists, $type, $regex, $contains, and the comparison operators $gt, $gte, $lt, and $lte. Comparison clauses evaluate typed metadata (number, decimal, datetime, or date) and raise detailed validation errors when operands cannot be coerced. Regex filters allow the optional i flag for case-insensitive matching, while $contains performs substring checks (case-insensitive by default, configurable via case_sensitive). Filters can be nested freely, for example:

{
  "$and": [
    {"category": "policy"},
    {"$or": [{"region": "emea"}, {"priority": {"$in": ["p0", "p1"]}}]}
  ]
}

Returns a list of ChunkResult objects ordered by relevance.

post/retrieve/chunks

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

contentstring required
scorenumber required
document_idstring required
chunk_numberinteger required
metadataobject required
content_typestring required
filenamestring nullable
download_urlstring nullable
is_paddingboolean

Whether this chunk was added as padding