Skip to main content
POST
/
v3
/
documents
Add document
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({content: '<string>'})
};

fetch('https://api.supermemory.ai/v3/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
content
string
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.

​
containerTag
string

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

​
containerTags
string[]
deprecated
​
entityContext
string

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

Maximum string length: 1500
​
customId
string

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

​
metadata
object

Optional metadata for the document.

​
taskType
enum<string>

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

Available options:
memory,
superrag
​
filepath
string

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

​
filterByMetadata
object

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

​
dreaming
enum<string>

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.

Available options:
instant,
dynamic

Response

Document added successfully

​
id
string
required

Unique identifier of the document

​
status
string
required

Status of the document