Update document

PATCH/v3/documents/{id}

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

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

containerTag: optional 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: optional array of 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: optional 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.

customId: optional string

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

filepath: optional string

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

filterByMetadata: optional map[string or number or boolean or array of 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 of string

metadata: optional map[string or number or boolean or array of 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 of string

taskType: optional "memory" or "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

id: string

Unique identifier of the document

status: string

Status of the document

Update document

curl https://api.supermemory.ai/v3/documents/$ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
    -d '{
          "containerTag": "user_alex",
          "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",
          "filepath": "/documents/reports/file.pdf",
          "filterByMetadata": {
            "department": "engineering",
            "region": "us"
          },
          "metadata": {
            "source": "upload",
            "language": "en"
          },
          "taskType": "memory"
        }'

{
  "id": "id",
  "status": "status"
}

Returns Examples

{
  "id": "id",
  "status": "status"
}