Create Memory

Create a new memory for the current user.

This endpoint allows users to create personal memories that can be used for context in future conversations and interactions.

POST /api/v1/memories

Create Memory

cURL

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

import requests

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

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

fetch('https://api.example.com/api/v1/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/api/v1/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([
    'user_id' => '<string>',
    'memory' => '<string>',
    'memory_type' => 'user',
    '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"

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

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/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  \"user_id\": \"<string>\",\n  \"memory\": \"<string>\",\n  \"memory_type\": \"user\",\n  \"topics\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}"

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

200

{
  "memory_id": "<string>",
  "message": "<string>",
  "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

Body

application/json

Schema for creating a new memory.

user_id · string · required

The user ID who owns the memory.

memory · string · required

The memory content to store.

memory_type · string | null · default: user

The type of memory. 'user', 'agent', 'team', 'workflow'.

topics · string[] | null

Topics associated with the memory.

metadata · Metadata · object | null

Additional metadata for the memory.

Response

200

application/json

Successful Response

Schema for memory creation response.

memory_id · string · required

ID of the created memory.

message · string · required

Success message.

memory · MemoryResponse · object · required

The created memory details.

Show child attributes