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

Try it

JavaScript

JavaScript

import Morphik from 'morphik';

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

const documents = await client.search.documents({ query: 'x' });

console.log(documents);

200

[
  {
    "content_type": "<string>",
    "external_id": "<string>",
    "filename": "<string>",
    "metadata": {},
    "metadata_types": {},
    "storage_info": {},
    "storage_files": [
      {
        "bucket": "<string>",
        "key": "<string>",
        "version": 1,
        "filename": "<string>",
        "content_type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "system_metadata": {},
    "additional_metadata": {},
    "chunk_ids": [
      "<string>"
    ],
    "folder_name": "<string>",
    "end_user_id": "<string>",
    "app_id": "<string>"
  }
]

Headers

authorization · string

Body

application/json

Request model for searching documents by name

query · string · required

Search query for document names/filenames

Minimum string length: 1

limit · integer · default: 10

Number of documents to return

Required range: 1 <= x <= 100

filters · Filters · object

Optional metadata filters for documents

folder_name

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

end_user_id · string | null

Optional end-user scope for the search

Response

200

application/json

Successful Response

content_type · string · required

external_id · string

filename · string | null

metadata · Metadata · object

metadata_types · Metadata Types · object

Show child attributes

metadata_types. {key} · string

storage_info · Storage Info · object

storage_files · StorageFileInfo · object[]

Show child attributes

storage_files. bucket · string · required

storage_files. key · string · required

storage_files. version · integer · default: 1

storage_files. filename · string | null

storage_files. content_type · string | null

storage_files. timestamp · string<date-time>

system_metadata · System Metadata · object

additional_metadata · Additional Metadata · object

chunk_ids · string[]

folder_name · string | null

end_user_id · string | null

app_id · string | null