Skip to main content
POST
/
ingest
/
file
JavaScript
import Morphik from 'morphik';

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

const document = await client.ingest.ingestFile({ file: fs.createReadStream('path/to/file') });

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

multipart/form-data
file
file
required
metadata
string
default:{}
rules
string
default:[]
use_colpali
boolean | null
folder_name
string | null
end_user_id
string | null

Response

Successful Response

Represents a document stored in the database documents collection

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
I