> ## 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.

# Get Installed Canvas Extension Endpoint

> Get information about a specific installed canvas extension.



## OpenAPI

````yaml /openapi/agent-sdk.json get /api/canvas-extensions/installed/{extension_name}
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/canvas-extensions/installed/{extension_name}:
    get:
      tags:
        - Canvas Extensions
      summary: Get Installed Canvas Extension Endpoint
      description: Get information about a specific installed canvas extension.
      operationId: >-
        get_installed_canvas_extension_endpoint_api_canvas_extensions_installed__extension_name__get
      parameters:
        - description: Canvas extension name (lowercase alphanumeric, hyphens)
          in: path
          name: extension_name
          required: true
          schema:
            description: Canvas extension name (lowercase alphanumeric, hyphens)
            maxLength: 255
            minLength: 1
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            title: Extension Name
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstalledCanvasExtensionResponse'
          description: Successful Response
        '404':
          description: Canvas extension not installed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - APIKeyHeader: []
components:
  schemas:
    InstalledCanvasExtensionResponse:
      description: Response containing installed canvas extension information.
      properties:
        description:
          default: ''
          description: Canvas extension description
          title: Description
          type: string
        enabled:
          default: false
          description: Whether the canvas extension is enabled
          title: Enabled
          type: boolean
        install_path:
          description: Path where the extension is installed
          title: Install Path
          type: string
        installed_at:
          description: ISO 8601 timestamp of installation
          title: Installed At
          type: string
        manifest:
          anyOf:
            - $ref: '#/components/schemas/CanvasExtensionManifest'
            - type: 'null'
          description: >-
            The extension's validated manifest (display_name, contributes.pages,
            ...). None if the installed manifest can no longer be read.
        name:
          description: Canvas extension 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
        source:
          description: Original source (e.g., 'github:owner/repo')
          title: Source
          type: string
        version:
          default: ''
          description: Canvas extension version
          title: Version
          type: string
      required:
        - name
        - source
        - installed_at
        - install_path
      title: InstalledCanvasExtensionResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CanvasExtensionManifest:
      description: Canvas extension manifest (``canvas-extension.json``).
      properties:
        backend:
          anyOf:
            - $ref: '#/components/schemas/CanvasExtensionBackend'
            - type: 'null'
          description: Optional explicitly prepared and started backend service
        contributes:
          $ref: '#/components/schemas/CanvasExtensionContributes'
          description: Contributions this extension makes to the Canvas UI
        description:
          default: ''
          description: Extension description
          title: Description
          type: string
        display_name:
          description: Human-readable extension name
          title: Display Name
          type: string
        entrypoint:
          description: >-
            Path, relative to the extension package root, to the bundle entry
            file
          title: Entrypoint
          type: string
        icon:
          anyOf:
            - type: string
            - type: 'null'
          description: Path, relative to the extension package root, to an SVG icon
          title: Icon
        name:
          description: Extension name (kebab-case)
          title: Name
          type: string
        schema_version:
          description: Manifest schema version
          title: Schema Version
          type: integer
        version:
          description: Extension version
          title: Version
          type: string
      required:
        - schema_version
        - name
        - display_name
        - version
        - entrypoint
      title: CanvasExtensionManifest
      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
    CanvasExtensionBackend:
      description: Optional trusted backend declaration for schema-1 Canvas Apps.
      properties:
        argv:
          items:
            type: string
          minItems: 1
          title: Argv
          type: array
        artifacts:
          additionalProperties:
            $ref: '#/components/schemas/CanvasExtensionBackendArtifact'
          minProperties: 1
          propertyNames:
            enum:
              - linux-amd64
              - linux-arm64
          title: Artifacts
          type: object
        health:
          $ref: '#/components/schemas/CanvasExtensionBackendHealth'
        inherit_environment:
          items:
            type: string
          title: Inherit Environment
          type: array
        schema_version:
          const: 1
          title: Schema Version
          type: integer
      required:
        - schema_version
        - artifacts
        - argv
      title: CanvasExtensionBackend
      type: object
    CanvasExtensionContributes:
      description: Contributions an extension makes to the Canvas UI.
      properties:
        pages:
          description: Pages contributed to Canvas navigation
          items:
            $ref: '#/components/schemas/CanvasExtensionPage'
          title: Pages
          type: array
      title: CanvasExtensionContributes
      type: object
    CanvasExtensionBackendArtifact:
      description: Immutable backend artifact for one supported platform.
      properties:
        path:
          description: Package-relative .tar.gz artifact path
          title: Path
          type: string
        sha256:
          description: Lowercase SHA-256 checksum
          pattern: ^[0-9a-f]{64}$
          title: Sha256
          type: string
      required:
        - path
        - sha256
      title: CanvasExtensionBackendArtifact
      type: object
    CanvasExtensionBackendHealth:
      description: Loopback HTTP readiness probe for a backend process.
      properties:
        interval_seconds:
          default: 0.1
          exclusiveMinimum: 0
          maximum: 10
          title: Interval Seconds
          type: number
        path:
          default: /health
          pattern: ^/[A-Za-z0-9._~!$&'()*+,;=:@%/-]*$
          title: Path
          type: string
        timeout_seconds:
          default: 30
          exclusiveMinimum: 0
          maximum: 300
          title: Timeout Seconds
          type: number
      title: CanvasExtensionBackendHealth
      type: object
    CanvasExtensionPage:
      description: A single page contributed to the Canvas UI by an extension.
      properties:
        id:
          description: Unique contribution id within the extension
          title: Id
          type: string
        path:
          description: Route the page is mounted at, e.g. '/dashboard'
          title: Path
          type: string
        title:
          description: Page title shown in Canvas navigation
          title: Title
          type: string
      required:
        - id
        - title
        - path
      title: CanvasExtensionPage
      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.