Create Memory

Create a new user memory with content and associated topics. Memories are used to store contextual information for users across conversations.

POST /memories

Create Memory

cURL

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

import requests

url = "https://api.example.com/memories"

payload = {
    "memory": "<string>",
    "user_id": "<string>",
    "topics": ["<string>"]
}
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>']})
};

fetch('https://api.example.com/memories', 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/memories",
  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>'
    ]
  ]),
  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/memories"

	payload := strings.NewReader("{\n  \"memory\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"topics\": [\n    \"<string>\"\n  ]\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/memories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memory\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"topics\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/memories")

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}"

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

200

{
  "memory_id": "mem-123",
  "memory": "User prefers technical explanations with code examples",
  "topics": [
    "preferences",
    "communication_style",
    "technical"
  ],
  "user_id": "user-456",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

db_id · string | null

Database ID to use for memory storage

table · string | null

Table to use for memory storage

Body

application/json

Define the payload expected for creating a new user memory

memory · string · required

Memory content text

Required string length: 1 - 5000

user_id · string | null

User ID who owns this memory

topics · string[] | null

Topics or tags to categorize the memory

Response

200

application/json

Memory created successfully

memory_id · string · required

Unique identifier for the memory

memory · string · required

Memory content text

topics · string[] | null

Topics or tags associated with the memory

agent_id · string | null

Agent ID associated with this memory

team_id · string | null

Team ID associated with this memory

user_id · string | null

User ID who owns this memory

updated_at · string<date-time> | null

Timestamp when memory was last updated