Skip to main content
PATCH
/
v3
/
documents
/
{id}
Update document
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    containerTag: 'user_alex',
    containerTags: ['<string>'],
    content: 'Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s.',
    customId: 'doc-api-rate-limits',
    metadata: {source: 'upload', language: 'en'},
    taskType: 'memory',
    filepath: '/documents/reports/file.pdf',
    filterByMetadata: {department: 'engineering', region: 'us'}
  })
};

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

Documentation Index

Fetch the complete documentation index at: https://supermemory.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

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

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

"user_alex"

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

Maximum string length: 100
Pattern: ^[a-zA-Z0-9_:-]+$
​
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.

Example:

"Our API rate limits are 100 req/min on free and 1000 on pro. Clients should use exponential backoff on 429s."

​
customId
string

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

Example:

"doc-api-rate-limits"

​
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:
{ "source": "upload", "language": "en" }
​
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
Example:

"memory"

​
filepath
string

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

Example:

"/documents/reports/file.pdf"

​
filterByMetadata
object

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.

Example:
{
  "department": "engineering",
  "region": "us"
}

Response

Document updated successfully

​
id
string
required

Unique identifier of the document

​
status
string
required

Status of the document