Skip to main content
POST
Replace document with file

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

namespace
string
required

The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_:-]+$
Example:

"user_alex"

id
string
required

The public document ID

Required string length: 1 - 255
Example:

"my-doc-123"

Body

multipart/form-data
file
file
required

File contents to upload

supportingContext
string

Context used to guide memory extraction within this namespace. Max 1500 characters.

Maximum string length: 1500
Example:

"Focus on product decisions, dates, and owners."

metadata
string

JSON-encoded metadata to attach to the document and its derived memories

group
string

JSON-encoded metadata used to keep related context isolated during processing and recall

date
string

When the source content is from, in ISO 8601 format

Example:

"2026-01-15"

taskType
enum<string>

Processing pipeline. "memory" builds durable learned context; "superrag" optimizes the document for retrieval without generating memories.

Available options:
memory,
superrag
dreaming
enum<string>

Processing mode. "dynamic" (default) groups related documents so memories form from coherent context. "instant" processes each document independently right away and bills one extra operation per document.

Available options:
dynamic,
instant
fileType
enum<string>

Explicit source type used when automatic inference is insufficient

Available options:
text,
pdf,
image,
video,
audio
mimeType
string

Explicit MIME type used when upload metadata is insufficient

Pattern: ^[^\s/]+\/[^\s/]+$

Response

Replacement accepted for processing

id
string
required

Document identifier to poll or retrieve

Minimum string length: 1
status
enum<string>
required

The document's processing state after this request. queued when new work was queued; otherwise its current state, e.g. done for an unchanged duplicate or failed for a metadata-only update to a failed document.

Available options:
unknown,
queued,
extracting,
chunking,
embedding,
indexing,
done,
failed