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

# Download a skill for local agents

> Download a skill's folder as a ZIP to install in a local agent. The archive holds one directory, named after the skill, with its SKILL.md and every other file. Unzip it into the agent's skills directory, such as `~/.claude/skills/`.

The ETag is the skill's contentHash, quoted. Send it as If-None-Match to get 304 Not Modified when the installed copy is current. An unknown skill ID returns 404. Free, read-only and safe to retry.



## OpenAPI

````yaml /openapi.json get /skills/{skillId}/bundle
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /skills/{skillId}/bundle:
    get:
      tags:
        - Skills
      summary: Download a skill for local agents
      description: >-
        Download a skill's folder as a ZIP to install in a local agent. The
        archive holds one directory, named after the skill, with its SKILL.md
        and every other file. Unzip it into the agent's skills directory, such
        as `~/.claude/skills/`.


        The ETag is the skill's contentHash, quoted. Send it as If-None-Match to
        get 304 Not Modified when the installed copy is current. An unknown
        skill ID returns 404. Free, read-only and safe to retry.
      operationId: downloadSkill
      parameters:
        - schema:
            type: string
            maxLength: 74
            pattern: ^effective:[a-z0-9]+(?:-[a-z0-9]+)*$
            description: >-
              Skill ID: its source and name, such as `effective:effective`.
              Stable while the skill keeps its name.
            example: effective:effective
          required: true
          description: >-
            Skill ID: its source and name, such as `effective:effective`. Stable
            while the skill keeps its name.
          name: skillId
          in: path
        - schema:
            type: string
            description: The ETag of the installed copy; a match returns 304 with no body.
          required: false
          description: The ETag of the installed copy; a match returns 304 with no body.
          name: if-none-match
          in: header
      responses:
        '200':
          description: The skill folder as a ZIP. ETag is its contentHash, quoted.
          headers:
            ETag:
              schema:
                type: string
          content:
            application/zip:
              schema:
                type: string
                format: binary
        '304':
          description: The installed copy is current.
          headers:
            ETag:
              schema:
                type: string
        '400':
          description: Invalid skill ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Credential not permitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: No skill has this ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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