Add Memories

curl --request POST \
  --url http://localhost:8080/api/v2/memories \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "producer": "user",
      "produced_for": "",
      "timestamp": "2023-11-07T05:31:56Z",
      "role": "",
      "metadata": {},
      "episode_type": "message"
    }
  ],
  "org_id": "universal",
  "project_id": "universal",
  "types": []
}
'

import requests

url = "http://localhost:8080/api/v2/memories"

payload = {
    "messages": [
        {
            "content": "<string>",
            "producer": "user",
            "produced_for": "",
            "timestamp": "2023-11-07T05:31:56Z",
            "role": "",
            "metadata": {},
            "episode_type": "message"
        }
    ],
    "org_id": "universal",
    "project_id": "universal",
    "types": []
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [
      {
        content: '<string>',
        producer: 'user',
        produced_for: '',
        timestamp: '2023-11-07T05:31:56Z',
        role: '',
        metadata: {},
        episode_type: 'message'
      }
    ],
    org_id: 'universal',
    project_id: 'universal',
    types: []
  })
};

fetch('http://localhost:8080/api/v2/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v2/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([
    'messages' => [
        [
                'content' => '<string>',
                'producer' => 'user',
                'produced_for' => '',
                'timestamp' => '2023-11-07T05:31:56Z',
                'role' => '',
                'metadata' => [
                                
                ],
                'episode_type' => 'message'
        ]
    ],
    'org_id' => 'universal',
    'project_id' => 'universal',
    'types' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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 := "http://localhost:8080/api/v2/memories"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}")

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

	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("http://localhost:8080/api/v2/memories")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v2/memories")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}"

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

{
  "results": [
    {
      "uid": "<string>"
    }
  ]
}

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

Memories

Add Memories

Add memory messages to a project.

The types field in the request specifies which memory types to add to:

If types is empty or not provided, memories are added to all types (episodic and semantic)
If types only contains "episodic", memories are added only to Episodic memory
If types only contains "semantic", memories are added only to Semantic memory
If types contains both, memories are added to both types

Each memory message represents a discrete piece of information to be stored in the project’s memory system. Messages can include content, metadata, timestamps, and other contextual details.

The producer field indicates who created the message, while the produced_for field specifies the intended recipient. These fields help provide context for the memory and if provided should be user-friendly names.

The endpoint accepts a batch of messages to be added in a single request.

POST

api

memories

Add Memories

curl --request POST \
  --url http://localhost:8080/api/v2/memories \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "producer": "user",
      "produced_for": "",
      "timestamp": "2023-11-07T05:31:56Z",
      "role": "",
      "metadata": {},
      "episode_type": "message"
    }
  ],
  "org_id": "universal",
  "project_id": "universal",
  "types": []
}
'

import requests

url = "http://localhost:8080/api/v2/memories"

payload = {
    "messages": [
        {
            "content": "<string>",
            "producer": "user",
            "produced_for": "",
            "timestamp": "2023-11-07T05:31:56Z",
            "role": "",
            "metadata": {},
            "episode_type": "message"
        }
    ],
    "org_id": "universal",
    "project_id": "universal",
    "types": []
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [
      {
        content: '<string>',
        producer: 'user',
        produced_for: '',
        timestamp: '2023-11-07T05:31:56Z',
        role: '',
        metadata: {},
        episode_type: 'message'
      }
    ],
    org_id: 'universal',
    project_id: 'universal',
    types: []
  })
};

fetch('http://localhost:8080/api/v2/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_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v2/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([
    'messages' => [
        [
                'content' => '<string>',
                'producer' => 'user',
                'produced_for' => '',
                'timestamp' => '2023-11-07T05:31:56Z',
                'role' => '',
                'metadata' => [
                                
                ],
                'episode_type' => 'message'
        ]
    ],
    'org_id' => 'universal',
    'project_id' => 'universal',
    'types' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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 := "http://localhost:8080/api/v2/memories"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}")

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

	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("http://localhost:8080/api/v2/memories")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v2/memories")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"producer\": \"user\",\n      \"produced_for\": \"\",\n      \"timestamp\": \"2023-11-07T05:31:56Z\",\n      \"role\": \"\",\n      \"metadata\": {},\n      \"episode_type\": \"message\"\n    }\n  ],\n  \"org_id\": \"universal\",\n  \"project_id\": \"universal\",\n  \"types\": []\n}"

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

{
  "results": [
    {
      "uid": "<string>"
    }
  ]
}

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

Body

application/json

Specification model for adding memories.

messages

MemoryMessage · object[]

required

A list of messages to be added (batch input).
Must contain at least one message.

Minimum array length: 1

Show child attributes

org_id

string

default:universal

The unique identifier of the organization.

- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, colon, and Unicode
  characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
  are allowed.

This value determines the namespace the project belongs to.

Examples:

"MemVerge"

"AI_Labs"

project_id

string

default:universal

The identifier of the project.

- Must be unique within the organization.
- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, colon, and Unicode
  characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
  are allowed.

This ID is used in API paths and resource locations.

Examples:

"memmachine"

"research123"

"qa_pipeline"

types

enum<string>[]

A list of memory types to include in the search (e.g., episodic, semantic).
If empty, all available types are searched.

Memory type.

Available options:

semantic,

episodic

Example:

["episodic", "semantic"]

Response

Successful Response

Response model for adding memories.

results

AddMemoryResult · object[]

required

The list of results for each added memory message.

Show child attributes

Get Short Term Memory Config

Delete Episodic Memory

Introduction

MCP Tools

REST API

Typescript REST SDK

PythonSDK Client

Python SDK Server

Add Memories

Body

Response