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

Try it

JavaScript

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: 'My API Key',
});

const response = await client.retrieve.createDocs();

console.log(response);

200

[
  {
    "score": 123,
    "document_id": "<string>",
    "metadata": {},
    "content": {
      "type": "url",
      "value": "<string>",
      "filename": "<string>"
    },
    "additional_metadata": {}
  }
]

Headers

authorization · string

Body

application/json

Base retrieve request model

query · string | null

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

Minimum string length: 1

query_image · string | null

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

filters · Filters · object

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

k · integer · default: 4

Maximum number of chunks or documents to return.

min_score · number · default: 0

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

use_reranking · boolean | null

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

use_colpali · boolean | null

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

output_format · enum<string> | null · default: base64

How to return image chunks: base64 data URI (default) or a presigned URL

Available options: base64, url

padding · integer · default: 0

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

Required range: x >= 0

graph_name · string | null

Name of the graph to use for knowledge graph-enhanced retrieval

hop_depth · integer | null · default: 1

Number of relationship hops to traverse in the graph

Required range: 1 <= x <= 3

include_paths · boolean | null · default: false

Whether to include relationship paths in the response

folder_name

Optional folder scope for the operation. Accepts a single folder name or a list of folder names.

end_user_id · string | null

Optional end-user scope for the operation

Response

200

application/json

Successful Response

score · number · required

document_id · string · required

metadata · Metadata · object · required

content · DocumentContent · object · required

Represents either a URL or content string

Show child attributes

content. type · enum<string> · required

Available options: url, string

content. value · string · required

content. filename · string | null

Filename when type is url

additional_metadata · Additional Metadata · object · required