Skip to content
supermemory-new
Get started
API Reference
Documents

Batch add documents

client.documents.batchAdd(DocumentBatchAddParams { documents, containerTag, containerTags, 6 more } body, RequestOptionsoptions?): DocumentBatchAddResponse { failed, results, success }
POST/v3/documents/batch

Add multiple documents in a single request. Each document can have any content type (text, url, file, etc.) and metadata

ParametersExpand Collapse
body: DocumentBatchAddParams { documents, containerTag, containerTags, 6 more }
documents: Array<UnionMember0> | Array<string>
One of the following:
Array<UnionMember0>
content: string

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

Plaintext: Any plaintext format

URL: A URL to a website, PDF, image, or video

We automatically detect the content type from the url’s response format.

containerTag?: string

Optional tag this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

maxLength100
DeprecatedcontainerTags?: Array<string>

(DEPRECATED: Use containerTag instead) Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

customId?: string

Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.

entityContext?: string

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

maxLength1500
filepath?: string

Optional file path for the document (e.g., ‘/documents/reports/file.pdf’). Used by supermemoryfs to map documents to filesystem paths.

filterByMetadata?: Record<string, string | number | boolean | Array<string>>

Optional metadata filter scoping which existing memories are pulled as context during ingestion. Scalar values match exactly (AND across keys); array values match ANY (OR within key). Only memories whose source documents match this filter are used as context.

One of the following:
string
number
boolean
Array<string>
metadata?: Record<string, string | number | boolean | Array<string>>

Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.

One of the following:
string
number
boolean
Array<string>
taskType?: "memory" | "superrag"

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

One of the following:
"memory"
"superrag"
Array<string>
containerTag?: string

Optional tag this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

maxLength100
DeprecatedcontainerTags?: Array<string>

(DEPRECATED: Use containerTag instead) Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.

content?: unknown
entityContext?: string

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

maxLength1500
filepath?: string

Optional file path for the document (e.g., ‘/documents/reports/file.pdf’). Used by supermemoryfs to map documents to filesystem paths.

filterByMetadata?: Record<string, string | number | boolean | Array<string>>

Optional metadata filter scoping which existing memories are pulled as context during ingestion. Scalar values match exactly (AND across keys); array values match ANY (OR within key). Only memories whose source documents match this filter are used as context.

One of the following:
string
number
boolean
Array<string>
metadata?: Record<string, string | number | boolean | Array<string>>

Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.

One of the following:
string
number
boolean
Array<string>
taskType?: "memory" | "superrag"

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

One of the following:
"memory"
"superrag"
ReturnsExpand Collapse
DocumentBatchAddResponse { failed, results, success }
failed: number

Count of documents that failed to add

results: Array<Result>

Array of results for each document in the batch

id: string

Unique identifier of the document (empty string for failed items)

status: string

Status of the document (e.g. ‘done’, ‘queued’, ‘error’)

details?: string

Additional error details when status is ‘error’

error?: string

Error message when status is ‘error’

success: number

Count of documents successfully added

Batch add documents

import Supermemory from 'supermemory';

const client = new Supermemory({
  apiKey: process.env['SUPERMEMORY_API_KEY'], // This is the default and can be omitted
});

const response = await client.documents.batchAdd({
  documents: [
    {
      content:
        'Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.',
    },
  ],
});

console.log(response.failed);
{
  "failed": 0,
  "results": [
    {
      "id": "id",
      "status": "status",
      "details": "details",
      "error": "error"
    }
  ],
  "success": 0
}
Returns Examples
{
  "failed": 0,
  "results": [
    {
      "id": "id",
      "status": "status",
      "details": "details",
      "error": "error"
    }
  ],
  "success": 0
}