Skip to main content
POST
memory.forget

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
namespace
string
required

Which set of documents to work on: an id you choose per user, project or tenant (letters, digits, "_", ":", "-", at most 83 characters). Use the same value across the memory capabilities.

Required string length: 1 - 83
Pattern: ^[a-zA-Z0-9_:-]+$
query
string
required

Which memories to forget, in plain words, e.g. "everything about the retired pricing plans".

Required string length: 1 - 2000
dryRun
boolean
default:true

True (the default) only previews the matching memories and changes nothing. Deleting requires dryRun: false explicitly; forgotten memories stop being recallable and this cannot be undone.

Response

The result

dryRun
boolean
required

True when this call only previewed the matches without forgetting anything.

count
number
required

How many memories matched the query (previewed or forgotten).

matches
string[]
required

The matching memories' text, so a preview can be reviewed.