Replace Memory

Replace an existing memory with new content.

This completely replaces the memory content while preserving the memory ID. Unlike update, this requires all fields to be provided and replaces the entire memory. The original creation timestamp is preserved, but updated_at is set to now.

Only the memory owner can replace their memories.

POST /api/v1/memories/{memory_id}/replace

Replace Memory

cURL

curl --request POST \
  --url https://api.example.com/api/v1/memories/{memory_id}/replace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memory": "<string>",
  "user_id": "<string>",
  "topics": [
    "<string>"
  ],
  "metadata": {}
}
'

import requests

url = "https://api.example.com/api/v1/memories/{memory_id}/replace"

payload = {
    "memory": "<string>",
    "user_id": "<string>",
    "topics": ["<string>"],
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({memory: '<string>', user_id: '<string>', topics: ['<string>'], metadata: {}})
};

fetch('https://api.example.com/api/v1/memories/{memory_id}/replace', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/memories/{memory_id}/replace",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'memory' => '<string>',
    'user_id' => '<string>',
    'topics' => [
        '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/memories/{memory_id}/replace"

	payload := strings.NewReader("{\n  \"memory\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"topics\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/memories/{memory_id}/replace")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memory\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"topics\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/memories/{memory_id}/replace")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memory\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"topics\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "memory_id": "<string>",
  "message": "<string>",
  "old_memory": {
    "memory_id": "<string>",
    "user_id": "<string>",
    "memory": "<string>",
    "topics": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "new_memory": {
    "memory_id": "<string>",
    "user_id": "<string>",
    "memory": "<string>",
    "topics": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

X-Workspace-Id · string | null

The workspace ID

Path Parameters

memory_id · string · required

Body

application/json

Schema for replacing a memory.

memory · string · required

The new memory content to replace the existing one.

user_id · string | null

The user ID who owns the memory.

topics · string[] | null

New topics for the memory.

metadata · Metadata · object | null

New metadata for the memory.

Response

200

application/json

Successful Response

Schema for memory replacement response.

memory_id · string · required

ID of the replaced memory.

message · string · required

Success message.

old_memory · MemoryResponse · object · required

The old memory details.

Show child attributes

new_memory · MemoryResponse · object · required

The new memory details.

Show child attributes