openapi: 3.1.0
info:
  title: Agno API Reference A2A Core API
  description: The all-in-one, private, secure agent platform that runs in your cloud.
  version: 2.5.6
tags:
- name: Core
paths:
  /config:
    get:
      tags:
      - Core
      summary: Get OS Configuration
      description: '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'
      operationId: get_config
      responses:
        '200':
          description: OS configuration retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
              example:
                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: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
      - HTTPBearer: []
  /models:
    get:
      tags:
      - Core
      summary: Get Available Models
      description: Retrieve a list of all unique models currently used by agents and teams in this OS instance. This includes the model ID and provider information for each model.
      operationId: get_models
      responses:
        '200':
          description: List of models retrieved successfully
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Model'
                type: array
                title: Response Get Models
              example:
              - id: gpt-4
                provider: openai
              - id: claude-3-sonnet
                provider: anthropic
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
      - HTTPBearer: []
components:
  schemas:
    DatabaseConfig_MemoryDomainConfig_:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/MemoryDomainConfig'
          - type: 'null'
        tables:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - db_id
      title: DatabaseConfig[MemoryDomainConfig]
    TracesConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatabaseConfig_TracesDomainConfig_'
            type: array
          - type: 'null'
          title: Dbs
      type: object
      title: TracesConfig
      description: Configuration for the Traces domain of the AgentOS
    InternalServerErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error detail message
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: Error code for categorization
      type: object
      required:
      - detail
      title: InternalServerErrorResponse
      example:
        detail: Internal server error
        error_code: INTERNAL_SERVER_ERROR
    KnowledgeConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/KnowledgeDatabaseConfig'
            type: array
          - type: 'null'
          title: Dbs
        knowledge_instances:
          anyOf:
          - items:
              $ref: '#/components/schemas/KnowledgeInstanceConfig'
            type: array
          - type: 'null'
          title: Knowledge Instances
      type: object
      title: KnowledgeConfig
      description: Configuration for the Knowledge domain of the AgentOS
    DatabaseConfig_EvalsDomainConfig_:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/EvalsDomainConfig'
          - type: 'null'
        tables:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - db_id
      title: DatabaseConfig[EvalsDomainConfig]
    MetricsDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: MetricsDomainConfig
      description: Configuration for the Metrics domain of the AgentOS
    MemoryDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: MemoryDomainConfig
      description: Configuration for the Memory domain of the AgentOS
    DatabaseConfig_SessionDomainConfig_:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/SessionDomainConfig'
          - type: 'null'
        tables:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - db_id
      title: DatabaseConfig[SessionDomainConfig]
    MetricsConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatabaseConfig_MetricsDomainConfig_'
            type: array
          - type: 'null'
          title: Dbs
      type: object
      title: MetricsConfig
      description: Configuration for the Metrics domain of the AgentOS
    EvalsConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        available_models:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Available Models
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatabaseConfig_EvalsDomainConfig_'
            type: array
          - type: 'null'
          title: Dbs
      type: object
      title: EvalsConfig
      description: Configuration for the Evals domain of the AgentOS
    MemoryConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatabaseConfig_MemoryDomainConfig_'
            type: array
          - type: 'null'
          title: Dbs
      type: object
      title: MemoryConfig
      description: Configuration for the Memory domain of the AgentOS
    UnauthenticatedResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error detail message
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: Error code for categorization
      type: object
      required:
      - detail
      title: UnauthenticatedResponse
      example:
        detail: Unauthenticated access
        error_code: UNAUTHENTICATED
    KnowledgeDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: KnowledgeDomainConfig
      description: Configuration for the Knowledge domain of the AgentOS
    InterfaceResponse:
      properties:
        type:
          type: string
          title: Type
          description: Type of the interface
        version:
          type: string
          title: Version
          description: Version of the interface
        route:
          type: string
          title: Route
          description: API route path
      type: object
      required:
      - type
      - version
      - route
      title: InterfaceResponse
    NotFoundResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error detail message
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: Error code for categorization
      type: object
      required:
      - detail
      title: NotFoundResponse
      example:
        detail: Not found
        error_code: NOT_FOUND
    TeamSummaryResponse:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Unique identifier for the team
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the team
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the team
        db_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Id
          description: Database identifier
        mode:
          anyOf:
          - type: string
          - type: 'null'
          title: Mode
          description: Team execution mode (coordinate, route, broadcast, tasks)
      type: object
      title: TeamSummaryResponse
    DatabaseConfig_TracesDomainConfig_:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/TracesDomainConfig'
          - type: 'null'
        tables:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - db_id
      title: DatabaseConfig[TracesDomainConfig]
    BadRequestResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error detail message
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: Error code for categorization
      type: object
      required:
      - detail
      title: BadRequestResponse
      example:
        detail: Bad request
        error_code: BAD_REQUEST
    ValidationErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Error detail message
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: Error code for categorization
      type: object
      required:
      - detail
      title: ValidationErrorResponse
      example:
        detail: Validation error
        error_code: VALIDATION_ERROR
    ChatConfig:
      properties:
        quick_prompts:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Quick Prompts
      type: object
      required:
      - quick_prompts
      title: ChatConfig
      description: Configuration for the Chat page of the AgentOS
    ConfigResponse:
      properties:
        os_id:
          type: string
          title: Os Id
          description: Unique identifier for the OS instance
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the OS instance
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the OS instance
        available_models:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Available Models
          description: List of available models
        os_database:
          anyOf:
          - type: string
          - type: 'null'
          title: Os Database
          description: ID of the database used for the OS instance
        databases:
          items:
            type: string
          type: array
          title: Databases
          description: List of database IDs used by the components of the OS instance
        chat:
          anyOf:
          - $ref: '#/components/schemas/ChatConfig'
          - type: 'null'
          description: Chat configuration
        session:
          anyOf:
          - $ref: '#/components/schemas/SessionConfig'
          - type: 'null'
          description: Session configuration
        metrics:
          anyOf:
          - $ref: '#/components/schemas/MetricsConfig'
          - type: 'null'
          description: Metrics configuration
        memory:
          anyOf:
          - $ref: '#/components/schemas/MemoryConfig'
          - type: 'null'
          description: Memory configuration
        knowledge:
          anyOf:
          - $ref: '#/components/schemas/KnowledgeConfig'
          - type: 'null'
          description: Knowledge configuration
        evals:
          anyOf:
          - $ref: '#/components/schemas/EvalsConfig'
          - type: 'null'
          description: Evaluations configuration
        traces:
          anyOf:
          - $ref: '#/components/schemas/TracesConfig'
          - type: 'null'
          description: Traces configuration
        agents:
          items:
            $ref: '#/components/schemas/AgentSummaryResponse'
          type: array
          title: Agents
          description: List of registered agents
        teams:
          items:
            $ref: '#/components/schemas/TeamSummaryResponse'
          type: array
          title: Teams
          description: List of registered teams
        workflows:
          items:
            $ref: '#/components/schemas/WorkflowSummaryResponse'
          type: array
          title: Workflows
          description: List of registered workflows
        interfaces:
          items:
            $ref: '#/components/schemas/InterfaceResponse'
          type: array
          title: Interfaces
          description: List of available interfaces
      type: object
      required:
      - os_id
      - databases
      - agents
      - teams
      - workflows
      - interfaces
      title: ConfigResponse
      description: Response schema for the general config endpoint
    Model:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Model identifier
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
          description: Model provider name
      type: object
      title: Model
    SessionConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        dbs:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatabaseConfig_SessionDomainConfig_'
            type: array
          - type: 'null'
          title: Dbs
      type: object
      title: SessionConfig
      description: Configuration for the Session domain of the AgentOS
    KnowledgeDatabaseConfig:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/KnowledgeDomainConfig'
          - type: 'null'
        tables:
          items:
            type: string
          type: array
          title: Tables
          default: []
      type: object
      required:
      - db_id
      title: KnowledgeDatabaseConfig
      description: Configuration for a knowledge database with its tables
    WorkflowSummaryResponse:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Unique identifier for the workflow
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the workflow
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the workflow
        db_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Id
          description: Database identifier
        is_component:
          type: boolean
          title: Is Component
          description: Whether this workflow was created via Builder
          default: false
        current_version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Current Version
          description: Current published version number
        stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Stage
          description: Stage of the loaded config (draft/published)
      type: object
      title: WorkflowSummaryResponse
    KnowledgeInstanceConfig:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        db_id:
          type: string
          title: Db Id
        table:
          type: string
          title: Table
      type: object
      required:
      - id
      - name
      - db_id
      - table
      title: KnowledgeInstanceConfig
      description: Configuration for a single knowledge instance
    SessionDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: SessionDomainConfig
      description: Configuration for the Session domain of the AgentOS
    DatabaseConfig_MetricsDomainConfig_:
      properties:
        db_id:
          type: string
          title: Db Id
        domain_config:
          anyOf:
          - $ref: '#/components/schemas/MetricsDomainConfig'
          - type: 'null'
        tables:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tables
      type: object
      required:
      - db_id
      title: DatabaseConfig[MetricsDomainConfig]
    TracesDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: TracesDomainConfig
      description: Configuration for the Traces domain of the AgentOS
    EvalsDomainConfig:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        available_models:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Available Models
      type: object
      title: EvalsDomainConfig
      description: Configuration for the Evals domain of the AgentOS
    AgentSummaryResponse:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Unique identifier for the agent
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the agent
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the agent
        db_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Db Id
          description: Database identifier
      type: object
      title: AgentSummaryResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer