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

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

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

console.log(documents);
[
  {
    "external_id": "<string>",
    "content_type": "<string>",
    "filename": "<string>",
    "metadata": {},
    "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 length: 1
limit
integer
default:10

Number of documents to return

Required range: 1 <= x <= 100
filters
object | null

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

Successful Response

content_type
string
required
external_id
string
filename
string | null
metadata
object
storage_info
object
storage_files
StorageFileInfo · object[]
system_metadata
object
additional_metadata
object
chunk_ids
string[]
folder_name
string | null
end_user_id
string | null
app_id
string | null