> ## Documentation Index
> Fetch the complete documentation index at: https://allhandsai-chore-regenerate-agent-sdk-openapi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Plugin Endpoint

> Install a plugin from a git URL, GitHub shorthand, or local path.



## OpenAPI

````yaml /openapi/agent-sdk.json post /api/plugins/install
openapi: 3.1.0
info:
  description: OpenHands Agent Server - REST/WebSocket interface for OpenHands AI Agent
  title: OpenHands Agent Server
  version: 1.52.0
servers: []
security: []
paths:
  /api/plugins/install:
    post:
      tags:
        - Plugins
      summary: Install Plugin Endpoint
      description: Install a plugin from a git URL, GitHub shorthand, or local path.
      operationId: install_plugin_endpoint_api_plugins_install_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallPluginRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstalledPluginResponse'
          description: Successful Response
        '400':
          description: Failed to fetch plugin source
        '409':
          description: Plugin already installed (use force=true)
        '422':
          description: Invalid plugin (bad name, etc.)
      security:
        - APIKeyHeader: []
components:
  schemas:
    InstallPluginRequest:
      description: Request body for installing a plugin.
      properties:
        force:
          default: false
          description: If true, overwrite existing installation
          title: Force
          type: boolean
        ref:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional branch, tag, or commit to install
          title: Ref
        repo_path:
          anyOf:
            - type: string
            - type: 'null'
          description: Subdirectory path within the repository (for monorepos)
          title: Repo Path
        source:
          description: >-
            Plugin source - git URL, GitHub shorthand, or local path. Examples:
            'github:OpenHands/extensions/plugins/city-weather',
            '/path/to/plugin'
          minLength: 1
          title: Source
          type: string
      required:
        - source
      title: InstallPluginRequest
      type: object
    InstalledPluginResponse:
      description: Response containing installed plugin information.
      properties:
        description:
          default: ''
          description: Plugin description
          title: Description
          type: string
        enabled:
          default: true
          description: Whether the plugin is enabled
          title: Enabled
          type: boolean
        files:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Plugin files, relative to install_path (None if load failed)
          title: Files
        install_path:
          description: Path where the plugin is installed
          title: Install Path
          type: string
        installed_at:
          description: ISO 8601 timestamp of installation
          title: Installed At
          type: string
        name:
          description: Plugin name
          title: Name
          type: string
        repo_path:
          anyOf:
            - type: string
            - type: 'null'
          description: Subdirectory path within the repository
          title: Repo Path
        resolved_ref:
          anyOf:
            - type: string
            - type: 'null'
          description: Resolved git commit SHA
          title: Resolved Ref
        skills:
          anyOf:
            - items:
                $ref: '#/components/schemas/PluginSkillSummary'
              type: array
            - type: 'null'
          description: Skills bundled in the plugin (None if it failed to load)
          title: Skills
        source:
          description: Original source (e.g., 'github:owner/repo')
          title: Source
          type: string
        version:
          default: ''
          description: Plugin version
          title: Version
          type: string
      required:
        - name
        - source
        - installed_at
        - install_path
      title: InstalledPluginResponse
      type: object
    PluginSkillSummary:
      description: Summary of a skill bundled in a plugin.
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        name:
          title: Name
          type: string
      required:
        - name
      title: PluginSkillSummary
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-Session-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.