Skip to navigation

Forget Memory

View as Markdown

Remove something from this user’s memory, its retained history and past-session search, in the background.

Authentication

AuthorizationBearer

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

Path parameters

project_idstringRequired
agent_slugstringRequired

Query parameters

directoryenumOptionalDefaults to agent
The shared agent directory, or one end user's directory.
Allowed values:
environmentenumOptionalDefaults to published
Allowed values:
tenantIdstring or nullOptional1-128 characters
userIdstring or nullOptional1-128 characters

Request

This endpoint expects an object.
targetstringRequired3-500 characters
What to forget, in plain words.

Response

Successful Response
attemptsinteger
conversationsHiddeninteger

Conversations dropped from past-session search.

createdAtdouble
finishedAtdouble or null
jobIdstring
removedinteger
Passages removed from memory.
statusenum
Allowed values:

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error