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);curl https://api.morphik.ai/documents/filename/$FILENAME \
-H "Authorization: Bearer $MORPHIK_API_KEY"{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Documents
Get Document By Filename
Get document by filename.
GET
/
documents
/
filename
/
{filename}
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);curl https://api.morphik.ai/documents/filename/$FILENAME \
-H "Authorization: Bearer $MORPHIK_API_KEY"{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Path Parameters
Query Parameters
Folder scope depth: 0/None = exact, -1 = all descendants, n > 0 = include descendants up to n levels.
Response
Successful Response
Represents a document stored in the database documents collection
Show child attributes
Show child attributes
Was this page helpful?

