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

GET /config

Get OS Configuration

cURL

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

200

{
  "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

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

OS configuration retrieved successfully

Response schema for the general config endpoint

os_id · string · required

Unique identifier for the OS instance

databases · string[] · required

List of database IDs used by the components of the OS instance

agents · AgentSummaryResponse · object[] · required

List of registered agents

Show child attributes

teams · TeamSummaryResponse · object[] · required

List of registered teams

Show child attributes

workflows · WorkflowSummaryResponse · object[] · required

List of registered workflows

Show child attributes

interfaces · InterfaceResponse · object[] · required

List of available interfaces

Show child attributes

name · string | null

Name of the OS instance

description · string | null

Description of the OS instance

available_models · string[] | null

List of available models

os_database · string | null

ID of the database used for the OS instance

chat · ChatConfig · object | null

Chat configuration

Show child attributes

session · SessionConfig · object | null

Session configuration

Show child attributes

metrics · MetricsConfig · object | null

Metrics configuration

Show child attributes

memory · MemoryConfig · object | null

Memory configuration

Show child attributes

knowledge · KnowledgeConfig · object | null

Knowledge configuration

Show child attributes

evals · EvalsConfig · object | null

Evaluations configuration

Show child attributes

traces · TracesConfig · object | null

Traces configuration

Show child attributes