Update namespace settings

Shape how Supermemory understands an existing namespace by updating the background context used during ingestion and memory formation.

PATCH /ns/{namespace}

Update namespace settings

TypeScript

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({supportingContext: 'This namespace holds Acme Corp support tickets.'})
};

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

200

{
  "namespace": "<string>",
  "supportingContext": "<string>",
  "system": {
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

namespace · string · required

Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.

Maximum string length: 100

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

Example:

"user_alex"

Body

application/json

supportingContext · string | null

Background that guides how Supermemory interprets documents and forms memories. Max 1500 characters. Set null to clear it.

Maximum string length: 1500

Example:

"This namespace holds Acme Corp support tickets."

Response

200

application/json

Updated namespace settings

namespace · string · required

Namespace identifier used in API paths

supportingContext · string | null · required

Background that helps Supermemory interpret documents and form better memories in this namespace

system · object · required

Namespace lifecycle timestamps

Show child attributes