Get Document By Filename

Get document by filename.

GET /documents/filename/{filename}

JavaScript

JavaScript

import Morphik from 'morphik';

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

const document = await client.documents.getByFilename('filename');

console.log(document.app_id);

200

{
  "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 | null

Path Parameters

filename · string · required

Query Parameters

folder_name · string string[]

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

Response

200

application/json

Successful Response

Represents a document stored in the database documents collection

content_type · string · required

external_id · string

filename · string | null

metadata · Metadata · object

metadata_types · Metadata Types · object

Show child attributes

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