Ingest File

Ingest a file asynchronously.

The file is uploaded to object storage, a Document stub is persisted with status='processing' and a background worker picks up the heavy parsing / chunking work.

POST /ingest/file

Try it

JavaScript

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);

200

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

Body

multipart/form-data

file · file · required

metadata · string · default: {}

metadata_types · string · default: {}

use_colpali · boolean | null

folder_name · string | null

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

metadata_types. {key} · string

storage_info · Storage Info · object

storage_files · StorageFileInfo · object[]

Show child attributes

storage_files. bucket · string · required

storage_files. key · string · required

storage_files. version · integer · default: 1

storage_files. filename · string | null

storage_files. content_type · string | null

storage_files. timestamp · string<date-time>

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