> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentarea.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Agent

> Add a built-in catalog agent to the workspace (copy-on-write fork).

Resolves a catalog agent by UUID or slug and materializes a tenant copy.
Idempotent: returns the existing workspace copy if already installed.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/agents/{agent_id}/install
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.0
servers: []
security:
  - bearer: []
paths:
  /v1/agents/{agent_id}/install:
    post:
      tags:
        - v1
        - protected
        - agents
      summary: Install Agent
      description: |-
        Add a built-in catalog agent to the workspace (copy-on-write fork).

        Resolves a catalog agent by UUID or slug and materializes a tenant copy.
        Idempotent: returns the existing workspace copy if already installed.
      operationId: install_agent_v1_agents__agent_id__install_post
      parameters:
        - in: path
          name: agent_id
          required: true
          schema:
            title: Agent Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    AgentResponse:
      properties:
        a2ui_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: A2Ui Enabled
        agent_type:
          default: stateless
          title: Agent Type
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        events_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Events Config
        id:
          format: uuid
          title: Id
          type: string
        instruction:
          anyOf:
            - type: string
            - type: 'null'
          title: Instruction
        is_catalog:
          default: false
          title: Is Catalog
          type: boolean
        model_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Id
        name:
          title: Name
          type: string
        planning:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Planning
        registry_item_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Registry Item Id
        skills:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Skills
        slug:
          title: Slug
          type: string
        status:
          title: Status
          type: string
        tools:
          anyOf:
            - items:
                discriminator:
                  mapping:
                    agent:
                      $ref: '#/components/schemas/AgentToolConfig'
                    code:
                      $ref: '#/components/schemas/CodeToolConfig'
                    mcp:
                      $ref: '#/components/schemas/McpToolConfig-Output'
                    openapi:
                      $ref: '#/components/schemas/OpenApiToolConfig'
                  propertyName: type
                oneOf:
                  - $ref: '#/components/schemas/CodeToolConfig'
                  - $ref: '#/components/schemas/McpToolConfig-Output'
                  - $ref: '#/components/schemas/AgentToolConfig'
                  - $ref: '#/components/schemas/OpenApiToolConfig'
              type: array
            - type: 'null'
          title: Tools
        update_available:
          default: false
          title: Update Available
          type: boolean
      required:
        - id
        - slug
        - name
        - status
      title: AgentResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AgentToolConfig:
      properties:
        name:
          title: Name
          type: string
        settings:
          anyOf:
            - $ref: '#/components/schemas/AgentToolSettings'
            - type: 'null'
        type:
          const: agent
          default: agent
          title: Type
          type: string
      required:
        - name
      title: AgentToolConfig
      type: object
    CodeToolConfig:
      properties:
        name:
          title: Name
          type: string
        settings:
          anyOf:
            - $ref: '#/components/schemas/CodeToolSettings'
            - type: 'null'
        type:
          const: code
          default: code
          title: Type
          type: string
      required:
        - name
      title: CodeToolConfig
      type: object
    McpToolConfig-Output:
      properties:
        name:
          title: Name
          type: string
        settings:
          anyOf:
            - $ref: '#/components/schemas/McpToolSettings'
            - type: 'null'
        type:
          const: mcp
          default: mcp
          title: Type
          type: string
      required:
        - name
      title: McpToolConfig
      type: object
    OpenApiToolConfig:
      properties:
        name:
          title: Name
          type: string
        settings:
          anyOf:
            - $ref: '#/components/schemas/OpenApiToolSettings'
            - type: 'null'
        type:
          const: openapi
          default: openapi
          title: Type
          type: string
      required:
        - name
      title: OpenApiToolConfig
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    AgentToolSettings:
      description: >-
        Settings for an agent-to-agent (delegation) tool.


        ``a2a_url`` selects the *remote* transport binding; absent →
        same-platform

        direct delegation. Lives here only — A2A is a per-edge binding, not a

        property every tool type carries.
      properties:
        a2a_url:
          anyOf:
            - type: string
            - type: 'null'
          title: A2A Url
        description_override:
          anyOf:
            - type: string
            - type: 'null'
          title: Description Override
        requires_user_confirmation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requires User Confirmation
      title: AgentToolSettings
      type: object
    CodeToolSettings:
      description: Settings for a built-in code toolset.
      properties:
        disabled_methods:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Disabled Methods
        requires_user_confirmation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requires User Confirmation
      title: CodeToolSettings
      type: object
    McpToolSettings:
      description: Settings for an MCP server tool (a subset of the server's tools).
      properties:
        allowed_tools:
          anyOf:
            - items:
                $ref: '#/components/schemas/McpToolPermission'
              type: array
            - type: 'null'
          title: Allowed Tools
        requires_user_confirmation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requires User Confirmation
      title: McpToolSettings
      type: object
    OpenApiToolSettings:
      description: >-
        Settings for an OpenAPI connection tool.


        ``load_mode`` picks schema disclosure: "explicit" inlines every
        operation's

        schema into each LLM call (legacy); "searchable" defers them behind a

        ``load_tools`` meta-tool. Honored only for openapi tools — which is
        exactly

        why it lives here and nowhere else.
      properties:
        allowed_tools:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Allowed Tools
        load_mode:
          anyOf:
            - enum:
                - explicit
                - searchable
              type: string
            - type: 'null'
          title: Load Mode
        openapi_connection_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Openapi Connection Id
        requires_user_confirmation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requires User Confirmation
      title: OpenApiToolSettings
      type: object
    McpToolPermission:
      description: >-
        A single MCP tool the agent may call.


        Replaces the old ``list[Any]`` for ``allowed_tools`` (the former FIXME).

        ``requires_user_confirmation`` is transport only: the API translates it
        into

        an agent-scoped approval policy rule and does not persist it here, so it
        is

        ``None`` at rest and reconstituted from rules on read.
      properties:
        requires_user_confirmation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requires User Confirmation
        tool_name:
          title: Tool Name
          type: string
      required:
        - tool_name
      title: McpToolPermission
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````