API reference · API
Change a memory's words or metadata
PATCH/v1/memories/{id}API key
A new text is embedded again, billed, and recorded as UPDATE in the history.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string |
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| memory | string | At most 2000 characters. |
| metadata | object or null |
Example
{
"memory": "string",
"metadata": {}
}Answer 200
The memory as it now stands.
Headers: x-antimatter-cost-micros
| Field | Type | What it is |
|---|---|---|
| id | string | mem_ and 24 hex digits. |
| object | "memory" | |
| space_id | string | |
| memory | string | The remembered text. |
| user | string or null | Your end user it is about. |
| metadata | object | |
| source | string | One of "explicit", "extracted", "chat", "agent". |
| confidence | number or null | 0 to 1, as the extraction gave it; null for a text written as is. |
| score | number | On a search: cosine similarity, 0 to 1. |
| created_at | integer | |
| updated_at | integer |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 404OpenAI shaped error.
- 409OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.