Create a memory for an agent

Create a memory

curl --request POST \
  --url https://api.onecli.sh/v1/agents/{agentId}/memories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "deploy-notes",
  "content": "<string>",
  "title": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}/memories"

payload = {
    "key": "deploy-notes",
    "content": "<string>",
    "title": "<string>",
    "description": "<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({
    key: 'deploy-notes',
    content: '<string>',
    title: '<string>',
    description: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/agents/{agentId}/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.onecli.sh/v1/agents/{agentId}/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([
    'key' => 'deploy-notes',
    'content' => '<string>',
    'title' => '<string>',
    'description' => '<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.onecli.sh/v1/agents/{agentId}/memories"

	payload := strings.NewReader("{\n  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\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.onecli.sh/v1/agents/{agentId}/memories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/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  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "agentId": "<string>",
  "key": "<string>",
  "title": "<string>",
  "description": "<string>",
  "lastRevisionSeq": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "content": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

agents

{agentId}

memories

Create a memory

curl --request POST \
  --url https://api.onecli.sh/v1/agents/{agentId}/memories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "deploy-notes",
  "content": "<string>",
  "title": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/agents/{agentId}/memories"

payload = {
    "key": "deploy-notes",
    "content": "<string>",
    "title": "<string>",
    "description": "<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({
    key: 'deploy-notes',
    content: '<string>',
    title: '<string>',
    description: '<string>'
  })
};

fetch('https://api.onecli.sh/v1/agents/{agentId}/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.onecli.sh/v1/agents/{agentId}/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([
    'key' => 'deploy-notes',
    'content' => '<string>',
    'title' => '<string>',
    'description' => '<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.onecli.sh/v1/agents/{agentId}/memories"

	payload := strings.NewReader("{\n  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\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.onecli.sh/v1/agents/{agentId}/memories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/agents/{agentId}/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  \"key\": \"deploy-notes\",\n  \"content\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "agentId": "<string>",
  "key": "<string>",
  "title": "<string>",
  "description": "<string>",
  "lastRevisionSeq": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "content": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Adds a new memory under a unique key. Use it to seed an agent with context, such as team conventions, before it starts work. Related guide: How it works: the gateway injects credentials. Keys are lowercase words separated by single hyphens and are unique per agent. Content is capped at 100,000 characters.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

agentId

string

required

Body

application/json

key

string

required

Maximum string length: 64

Example:

"deploy-notes"

content

string

required

Maximum string length: 100000

title

string

One line.

description

string

One line.

Response

Created

One memory without its content (the index projection).

string

agentId

string

key

string

The agent's own handle for the memory and its file name (memory/<key>.md). Immutable.

title

string | null

description

string | null

lastRevisionSeq

integer

createdAt

string<date-time>

updatedAt

string<date-time>

content

string

Workspace

Organization

Enterprise

Platform

Create a memory for an agent

Authorizations

Path Parameters

Body

Response