Patch Memory
Upsert the singleton memory row.
First write requires both agentFramework and memory.
Updates apply only the fields explicitly present in the body.
The reload pipeline reassembles + validates the engine config; a
framework/memory mismatch rolls back with a 422.
curl --request PATCH \
--url https://api.example.com/admin/api/v1/memory \
--header 'Content-Type: application/json' \
--data '
{
"memory": {
"type": "sqlite",
"db_url": "<string>"
}
}
'import requests
url = "https://api.example.com/admin/api/v1/memory"
payload = { "memory": {
"type": "sqlite",
"db_url": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({memory: {type: 'sqlite', db_url: '<string>'}})
};
fetch('https://api.example.com/admin/api/v1/memory', 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/admin/api/v1/memory",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'memory' => [
'type' => 'sqlite',
'db_url' => '<string>'
]
]),
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 := "https://api.example.com/admin/api/v1/memory"
payload := strings.NewReader("{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/admin/api/v1/memory")
.header("Content-Type", "application/json")
.body("{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/memory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agentFramework": "LANGGRAPH",
"memory": {
"type": "sqlite",
"db_url": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z"
},
"reload": {
"status": "reloaded",
"message": "<string>",
"error": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
Body for PATCH /admin/api/v1/memory. All fields optional.
Supported agent frameworks for engine.
LANGGRAPH, ADK, CREWAI, CUSTOM, TRANSLATION_AGENT, CORRECTION_AGENT, DEEP_RESEARCH_AGENT Configuration for SQLite checkpointer.
- SqliteCheckpointConfig
- InMemoryCheckpointConfig
- PostgresCheckpointConfig
- AdkInMemorySessionConfig
- AdkVertexAiSessionConfig
- AdkDatabaseSessionConfig
Show child attributes
Show child attributes
Response
Successful Response
GET response and the data payload of PATCH responses.
Show child attributes
Show child attributes
Reload outcome attached to every admin mutation response.
reloaded means DB committed and runtime now uses the new config.
restart_required means DB committed and process restart is needed.
reload_failed means DB rolled back and runtime is unchanged.
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.example.com/admin/api/v1/memory \
--header 'Content-Type: application/json' \
--data '
{
"memory": {
"type": "sqlite",
"db_url": "<string>"
}
}
'import requests
url = "https://api.example.com/admin/api/v1/memory"
payload = { "memory": {
"type": "sqlite",
"db_url": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({memory: {type: 'sqlite', db_url: '<string>'}})
};
fetch('https://api.example.com/admin/api/v1/memory', 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/admin/api/v1/memory",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'memory' => [
'type' => 'sqlite',
'db_url' => '<string>'
]
]),
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 := "https://api.example.com/admin/api/v1/memory"
payload := strings.NewReader("{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/admin/api/v1/memory")
.header("Content-Type", "application/json")
.body("{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/memory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"memory\": {\n \"type\": \"sqlite\",\n \"db_url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agentFramework": "LANGGRAPH",
"memory": {
"type": "sqlite",
"db_url": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z"
},
"reload": {
"status": "reloaded",
"message": "<string>",
"error": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}