Skip to main content
GET
/
config
{
  "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": []
}

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

Unique identifier for the OS instance

​
databases
string[]
required

List of database IDs

​
agents
AgentSummaryResponse · object[]
required

List of registered agents

​
teams
TeamSummaryResponse · object[]
required

List of registered teams

​
workflows
WorkflowSummaryResponse · object[]
required

List of registered workflows

​
interfaces
InterfaceResponse · object[]
required

List of available interfaces

​
name
string | null

Name of the OS instance

​
description
string | null

Description of the OS instance

​
available_models
string[] | null

List of available models

​
chat
object | null

Chat configuration Configuration for the Chat page of the AgentOS

​
session
object | null

Session configuration Configuration for the Session domain of the AgentOS

​
metrics
object | null

Metrics configuration Configuration for the Metrics domain of the AgentOS

​
memory
object | null

Memory configuration Configuration for the Memory domain of the AgentOS

​
knowledge
object | null

Knowledge configuration Configuration for the Knowledge domain of the AgentOS

​
evals
object | null

Evaluations configuration Configuration for the Evals domain of the AgentOS