Skip to main content
POST
/
v3
/
documents
/
batch
Batch add documents
const url = 'https://api.supermemory.ai/v3/documents/batch';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"documents":[{"containerTag":"user_123","containerTags":["user_123","project_123"],"content":"This is a detailed article about machine learning concepts...","customId":"mem_abc123","metadata":{"category":"technology","isPublic":true,"readingTime":5,"source":"web","tag_1":"ai","tag_2":"machine-learning"}}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
[
  {
    "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
​
documents
required
Required array length: 1 - 100 elements
​
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.

Example:

"user_123"

​
containerTags
string[]
deprecated

(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.

Example:
["user_123", "project_123"]
​
metadata
object

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.

Example:
{
  "category": "technology",
  "isPublic": true,
  "readingTime": 5,
  "source": "web",
  "tag_1": "ai",
  "tag_2": "machine-learning"
}
​
content
null

Response

Documents added successfully

​
id
string
required
​
status
string
required
⌘I