curl --request GET \
--url https://api.example.com/config \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/config"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/config', 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/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/config")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "demo",
"description": "Example AgentOS configuration",
"available_models": [],
"databases": [
"9c884dc4-9066-448c-9074-ef49ec7eb73c"
],
"session": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Sessions"
}
}
]
},
"metrics": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Metrics"
}
}
]
},
"memory": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Memory"
}
}
]
},
"knowledge": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Knowledge"
}
}
]
},
"evals": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Evals"
}
}
]
},
"agents": [
{
"id": "main-agent",
"name": "Main Agent",
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c"
}
],
"teams": [],
"workflows": [],
"interfaces": []
}{
"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"
}Get OS Configuration
Retrieve the complete configuration of the AgentOS instance, including:
- Available models and databases
- Registered agents, teams, and workflows
- Chat, session, memory, knowledge, and evaluation configurations
- Available interfaces and their routes
curl --request GET \
--url https://api.example.com/config \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/config"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/config', 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/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/config")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "demo",
"description": "Example AgentOS configuration",
"available_models": [],
"databases": [
"9c884dc4-9066-448c-9074-ef49ec7eb73c"
],
"session": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Sessions"
}
}
]
},
"metrics": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Metrics"
}
}
]
},
"memory": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Memory"
}
}
]
},
"knowledge": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Knowledge"
}
}
]
},
"evals": {
"dbs": [
{
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c",
"domain_config": {
"display_name": "Evals"
}
}
]
},
"agents": [
{
"id": "main-agent",
"name": "Main Agent",
"db_id": "9c884dc4-9066-448c-9074-ef49ec7eb73c"
}
],
"teams": [],
"workflows": [],
"interfaces": []
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OS configuration retrieved successfully
Response schema for the general config endpoint
Unique identifier for the OS instance
List of database IDs used by the components of the OS instance
List of registered agents
Show child attributes
Show child attributes
List of registered teams
Show child attributes
Show child attributes
List of registered workflows
Show child attributes
Show child attributes
List of available interfaces
Show child attributes
Show child attributes
Name of the OS instance
Description of the OS instance
List of available models
ID of the database used for the OS instance
Chat configuration
Show child attributes
Show child attributes
Session configuration
Show child attributes
Show child attributes
Metrics configuration
Show child attributes
Show child attributes
Memory configuration
Show child attributes
Show child attributes
Knowledge configuration
Show child attributes
Show child attributes
Evaluations configuration
Show child attributes
Show child attributes
Traces configuration
Show child attributes
Show child attributes
Was this page helpful?