Get OS Configuration

{
  "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": []
}

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

Show child attributes

agents.id

string | null

Unique identifier for the agent

agents.name

string | null

Name of the agent

agents.description

string | null

Description of the agent

agents.db_id

string | null

Database identifier

teams

TeamSummaryResponse · object[]

required

List of registered teams

Show child attributes

teams.id

string | null

Unique identifier for the team

teams.name

string | null

Name of the team

teams.description

string | null

Description of the team

teams.db_id

string | null

Database identifier

workflows

WorkflowSummaryResponse · object[]

required

List of registered workflows

Show child attributes

workflows.id

string | null

Unique identifier for the workflow

workflows.name

string | null

Name of the workflow

workflows.description

string | null

Description of the workflow

workflows.db_id

string | null

Database identifier

interfaces

InterfaceResponse · object[]

required

List of available interfaces

Show child attributes

interfaces.type

string

required

Type of the interface

interfaces.version

string

required

Version of the interface

interfaces.route

string

required

API route path

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

ChatConfig · object

Chat configuration

Show child attributes

chat.quick_prompts

Quick Prompts · object

required

Show child attributes

chat.quick_prompts.{key}

string[]

session

SessionConfig · object

Session configuration

Show child attributes

session.display_name

string | null

session.dbs

DatabaseConfig[SessionDomainConfig] · object[] | null

Show child attributes

session.dbs.db_id

string

required

session.dbs.domain_config

SessionDomainConfig · object

Configuration for the Session domain of the AgentOS

Show child attributes

session.dbs.domain_config.display_name

string | null

session.dbs.tables

string[] | null

metrics

MetricsConfig · object

Metrics configuration

Show child attributes

metrics.display_name

string | null

metrics.dbs

DatabaseConfig[MetricsDomainConfig] · object[] | null

Show child attributes

metrics.dbs.db_id

string

required

metrics.dbs.domain_config

MetricsDomainConfig · object

Configuration for the Metrics domain of the AgentOS

Show child attributes

metrics.dbs.domain_config.display_name

string | null

metrics.dbs.tables

string[] | null

memory

MemoryConfig · object

Memory configuration

Show child attributes

memory.display_name

string | null

memory.dbs

DatabaseConfig[MemoryDomainConfig] · object[] | null

Show child attributes

memory.dbs.db_id

string

required

memory.dbs.domain_config

MemoryDomainConfig · object

Configuration for the Memory domain of the AgentOS

Show child attributes

memory.dbs.domain_config.display_name

string | null

memory.dbs.tables

string[] | null

knowledge

KnowledgeConfig · object

Knowledge configuration

Show child attributes

knowledge.display_name

string | null

knowledge.dbs

DatabaseConfig[KnowledgeDomainConfig] · object[] | null

Show child attributes

knowledge.dbs.db_id

string

required

knowledge.dbs.domain_config

KnowledgeDomainConfig · object

Configuration for the Knowledge domain of the AgentOS

Show child attributes

knowledge.dbs.domain_config.display_name

string | null

knowledge.dbs.tables

string[] | null

evals

EvalsConfig · object

Evaluations configuration

Show child attributes

evals.display_name

string | null

evals.available_models

string[] | null

evals.dbs

DatabaseConfig[EvalsDomainConfig] · object[] | null

Show child attributes

evals.dbs.db_id

string

required

evals.dbs.domain_config

EvalsDomainConfig · object

Configuration for the Evals domain of the AgentOS

Show child attributes

evals.dbs.domain_config.display_name

string | null

evals.dbs.domain_config.available_models

string[] | null

evals.dbs.tables

string[] | null

Overview List All Agents

⌘I

Agno SDK Reference

AgentOS API Reference

Get OS Configuration

Authorizations

Response