Get OS Configuration

curl --request GET \
  --url https://api.example.com/config \
  --header 'Authorization: Bearer <token>'

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))

}

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

config

Get OS Configuration

curl --request GET \
  --url https://api.example.com/config \
  --header 'Authorization: Bearer <token>'

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))

}

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

Authorization

string

header

required

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

os_id

string

required

databases

string[]

required

agents

AgentSummaryResponse · object[]

required

Show child attributes

teams

TeamSummaryResponse · object[]

required

Show child attributes

workflows

WorkflowSummaryResponse · object[]

required

Show child attributes

interfaces

InterfaceResponse · object[]

required

Show child attributes

name

string | null

description

string | null

available_models

string[] | null

chat

ChatConfig · object | null

Configuration for the Chat page of the AgentOS

Show child attributes

session

SessionConfig · object | null

Configuration for the Session domain of the AgentOS

Show child attributes

metrics

MetricsConfig · object | null

Configuration for the Metrics domain of the AgentOS

Show child attributes

memory

MemoryConfig · object | null

Configuration for the Memory domain of the AgentOS

Show child attributes

knowledge

KnowledgeConfig · object | null

Configuration for the Knowledge domain of the AgentOS

Show child attributes

evals

EvalsConfig · object | null

Configuration for the Evals domain of the AgentOS

Show child attributes

AgentOS

Examples

AgentOS API

Reference

Get OS Configuration

Authorizations

Response