Sign in

v4

latestOpenAPI 3.1.02026-08-01420618.8 KB
Ingest

Add document

Add a document with any content type (text, url, file, etc.) and metadata

post/v3/documents

Request body

contentstring required

The content to extract and process into a document. This can be a URL to a website, a PDF, an image, or a video.

containerTagstring

Optional tag this document should be containerized by. Max 100 characters, alphanumeric with hyphens, underscores, and dots only.

containerTagsstring[]
entityContextstring

Optional entity context for this container tag. Max 1500 characters. Used during document processing to guide memory extraction.

customIdstring

Optional custom ID of the document. Max 100 characters, alphanumeric with hyphens, underscores, and dots only.

metadataobject

Optional metadata for the document.

taskType'memory' | 'superrag'

Task type: "memory" (default) for full context layer with SuperRAG built in, "superrag" for managed RAG as a service.

filepathstring

Optional file path for the document. Used by supermemoryfs to store the full path of the file.

filterByMetadataobject

Optional metadata filter to apply when pulling related memories and profile during ingestion. Only memories matching these filters will be used as context.

dreaming'instant' | 'dynamic'

Processing mode. "dynamic" (default) groups related documents together so memories form from coherent, logical units rather than one isolated entry at a time. "instant" processes each document on its own right away, and bills one extra operation per document.

Response

Document added successfully

idstring required

Unique identifier of the document

statusstring required

Status of the document