Delete documents

Permanently remove documents and their derived knowledge by document ID or caller-defined ID. Each requested ID is handled independently so successful deletions are preserved when another ID fails.

DELETE /ns/{namespace}/document

Delete documents

TypeScript

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: ['my-doc-123']})
};

fetch('https://api.supermemory.ai/ns/{namespace}/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "count": 4503599627370495,
  "errors": [
    {
      "id": "my-doc-123",
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

namespace · string · required

The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.

Maximum string length: 100

Pattern: ^[a-zA-Z0-9_:-]+$

Example:

"user_alex"

Body

application/json

ids · string[] · required

Document identifiers to permanently delete from this namespace

Required array length: 1 - 100 elements

A document ID or caller-defined ID

Required string length: 1 - 255

Example:

["my-doc-123"]

Response

200

application/json

Document deletion completed

count · integer · required

Number of documents successfully deleted

Required range: 0 <= x <= 9007199254740991

errors · object[] · required

Per-document failures; successful deletions are not rolled back

Show child attributes