FruxonDocs
ApiAgent memories

Forget every memory an agent holds about a single end-user.

Permanently removes all of the agent's per-end-user memories about the person the `subject` names in one call — the data-subject ("forget this person") deletion. Name the person by participant id or by the `"provider:identifier"` of one of their channel addresses; either form removes the memories filed under their participant id and those filed under any of their addresses. Each removed memory is recorded in the deletion trail first. Agent-global memories are untouched: an empty subject is rejected with 400 so the shared pool can never be wiped through this path. Requires the Admin collaborator role, matching single-memory deletion. Returns the number of memories removed (0 when the person had none).

POST
/v1/tenants/{tenant}/agents/{agent}/memories:forgetSubject

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The unique identifier of the agent.

tenant*string

The tenant identifier

Request Body

The subject whose memories should be forgotten.

subject*string

The end-user whose memories should all be forgotten: their participant id, or the "provider:identifier" of one of their channel addresses (e.g. "telegram:123456789"). Either form forgets the memories filed under the person's participant id and under each of their addresses.

Length1 <= length <= 512
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string/memories:forgetSubject" \  -H "Content-Type: application/json" \  -d '{    "subject": "string"  }'
{
  "deletedCount": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty