Skip to main content
POST
/
documents
/
{document_id}
/
update_metadata
JavaScript
import Morphik from 'morphik';

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

const document = await client.documents.updateMetadata('document_id');

console.log(document.app_id);
{
  "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

Path Parameters

​
document_id
string
required

Body

application/json

Request payload for metadata-only document updates.

​
metadata
Metadata · object

Metadata fields to merge into the document.

​
metadata_types
Metadata Types · object

Optional per-field type hints: 'string', 'number', 'decimal', 'datetime', 'date', 'boolean', 'array', 'object'. Enables typed comparisons.

Response

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
​
storage_info
Storage Info · object
​
storage_files
StorageFileInfo · object[]
​
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