API reference

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

Path and query parameters
FieldTypeWhat it is
id (path)requiredstring

Request body

application/json, required

Request body fields
FieldTypeWhat it is
memorystringAt most 2000 characters.
metadataobject or null

Example

{
  "memory": "string",
  "metadata": {}
}

Answer 200

The memory as it now stands.

Headers: x-antimatter-cost-micros

Fields of the 200 answer
FieldTypeWhat it is
idstringmem_ and 24 hex digits.
object"memory"
space_idstring
memorystringThe remembered text.
userstring or nullYour end user it is about.
metadataobject
sourcestringOne of "explicit", "extracted", "chat", "agent".
confidencenumber or null0 to 1, as the extraction gave it; null for a text written as is.
scorenumberOn a search: cosine similarity, 0 to 1.
created_atinteger
updated_atinteger

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.

Antimatter