Skip to main content
POST
/
search
/
documents
JavaScript
import Morphik from 'morphik';

const client = new Morphik({
  apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});

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

console.log(documents);
[
  {
    "content_type": "<string>",
    "external_id": "<string>",
    "filename": "<string>",
    "metadata": {},
    "metadata_types": {},
    "storage_info": {},
    "system_metadata": {},
    "additional_metadata": {},
    "chunk_ids": [
      "<string>"
    ],
    "summary_storage_key": "<string>",
    "summary_version": 123,
    "summary_bucket": "<string>",
    "summary_updated_at": "<string>",
    "folder_name": "<string>",
    "end_user_id": "<string>",
    "app_id": "<string>",
    "folder_path": "<string>",
    "folder_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. Accepts a folder PATH (e.g., '/Company/Reports') or list of paths.

folder_depth
integer | null

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

end_user_id
string | null

Optional end-user scope for the search

Response

Successful Response

content_type
string
required
external_id
string
filename
string | null
metadata
Metadata · object
metadata_types
Metadata Types · object
storage_info
Storage Info · object
system_metadata
System Metadata · object
additional_metadata
Additional Metadata · object
chunk_ids
string[]
summary_storage_key
string | null
summary_version
integer | null
summary_bucket
string | null
summary_updated_at
string | null
folder_name
string | null
end_user_id
string | null
app_id
string | null
folder_path
string | null
folder_id
string | null