Ingest vault object

Triggers ingestion workflow for a vault object to extract text, generate chunks, and create embeddings. For supported file types (PDF, DOCX, PPTX, XLSX, TXT, RTF, XML, HTML, Markdown, CSV/TSV, JSON/YAML/TOML, common source code files, ZIP, audio, video), processing happens asynchronously. ZIP archives always return a processing response, are unpacked recursively up to 5 levels, and each extracted file is created as an independent vault object and ingested via the normal pipeline. For unsupported types (images, etc.), the file is marked as completed immediately without text extraction.

POST

vault

{id}

ingest

{objectId}

{
  "objectId": "obj_abc123",
  "workflowId": "wf_def456",
  "status": "processing",
  "message": "Document ingestion started. Text extraction, chunking, and embedding generation in progress."
}

Authorizations

Authorization

string

header

required

API key starting with sk_case_

Path Parameters

string

required

Vault ID

objectId

string

required

Vault object ID

Body

application/json

callback_url

string<uri>

Optional callback URL for asynchronous workflow completion.

page_boundaries

integer[]

Optional PDF pages that must begin a new chunk segment. Overlap never crosses these boundaries.

Required range: x >= 2

Response

Ingestion workflow started successfully

objectId

string

required

ID of the vault object being processed

workflowId

string | null

required

Workflow run ID for tracking progress. Null for file types that skip processing.

status

enum<string>

required

Current ingestion status. 'stored' for file types without text extraction (no chunks/vectors created).

Available options:

processing,

stored

message

string

required

Human-readable status message

{
  "objectId": "obj_abc123",
  "workflowId": "wf_def456",
  "status": "processing",
  "message": "Document ingestion started. Text extraction, chunking, and embedding generation in progress."
}

Compute

Connectors

System

Legal

Agents/Linc

LLMs

Matters

Media

Memory

OCR

Privilege

Search

Skills

Translation

Usage

Vaults

Vault Events

Vault Memory

Vault Objects

Voice

Webhooks

Ingest vault object

Authorizations

Path Parameters

Body

Response