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

# Release an uploaded program bundle

> Create a release: a version number that names one uploaded bundle. The response’s `endpoints` lists the operations the release serves, derived from what the bundle contains.

Send `releaseVersion` and the `bundleId` that [Upload a program bundle](/api-reference/your-programs/upload-a-program-bundle) returned. To make the release the latest, use a version above the program’s `latestReleaseVersion`.

A release is permanent. A version that names another bundle or other notes returns 409 `release_exists`; choose a higher version. Repeating an identical request is safe: it returns 200 with the release.

A new release that serves at once returns 201 with `state` `ready`. A release Effective still prepares to serve returns 202 with `state` `provisioning`. Poll [Get a program release](/api-reference/your-programs/get-a-program-release) at `Location` until it returns 200. Until then the release is not the latest.

Needs edit permission on the program.



## OpenAPI

````yaml /openapi.json post /rsl/{id}/releases
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:
  /rsl/{id}/releases:
    post:
      tags:
        - Your programs
      summary: Release an uploaded program bundle
      description: >-
        Create a release: a version number that names one uploaded bundle. The
        response’s `endpoints` lists the operations the release serves, derived
        from what the bundle contains.


        Send `releaseVersion` and the `bundleId` that [Upload a program
        bundle](/api-reference/your-programs/upload-a-program-bundle) returned.
        To make the release the latest, use a version above the program’s
        `latestReleaseVersion`.


        A release is permanent. A version that names another bundle or other
        notes returns 409 `release_exists`; choose a higher version. Repeating
        an identical request is safe: it returns 200 with the release.


        A new release that serves at once returns 201 with `state` `ready`. A
        release Effective still prepares to serve returns 202 with `state`
        `provisioning`. Poll [Get a program
        release](/api-reference/your-programs/get-a-program-release) at
        `Location` until it returns 200. Until then the release is not the
        latest.


        Needs edit permission on the program.
      operationId: createProgramRelease
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: >-
              Your organization’s ID for the program, chosen at its first
              upload: lowercase letters, digits, dots, underscores and hyphens.
              A rater’s program ID is its rater ID.
          required: true
          description: >-
            Your organization’s ID for the program, chosen at its first upload:
            lowercase letters, digits, dots, underscores and hyphens. A rater’s
            program ID is its rater ID.
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ProgramReleaseCreate'
      responses:
        '200':
          description: The identical release already existed. Nothing changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramRelease'
        '201':
          description: The new release, ready to serve.
          headers:
            Location:
              schema:
                type: string
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramRelease'
        '202':
          description: >-
            The new release, still provisioning. Poll Location until it returns
            200; Retry-After gives the interval in seconds.
          headers:
            Location:
              schema:
                type: string
              required: true
            Retry-After:
              schema:
                type: string
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramRelease'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: You lack edit permission on the program, or are a read-only member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            program_not_found, or bundle_not_found: the bundle was never
            uploaded for this program.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            release_exists: the version already names another bundle or other
            notes. Choose a higher version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: The body exceeds 64 KiB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: The request body is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Temporarily unavailable; retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ProgramReleaseCreate:
      type: object
      properties:
        releaseVersion:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 2147483647
          description: >-
            Version number for the new release. It must be unused for this
            program.
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: An uploaded bundle of this program, from uploadProgram.
        notes:
          type: string
          minLength: 1
          maxLength: 20000
          description: Markdown release notes, stored as metadata.notes.
      required:
        - releaseVersion
        - bundleId
      additionalProperties: false
    V2ProgramRelease:
      type: object
      properties:
        programId:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          description: >-
            Your organization’s ID for the program, chosen at its first upload:
            lowercase letters, digits, dots, underscores and hyphens. A rater’s
            program ID is its rater ID.
        releaseVersion:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: SHA-256 identity of the immutable program bundle.
        component:
          type: string
          enum:
            - rater
            - guideline
          description: >-
            What the program’s entry file is, as its `spec` states. A rater
            prices a risk. A guideline decides a submission step by step, and
            prices it with the raters it uses. The first upload fixes it: every
            bundle of one program has the same component.
        uses:
          type: array
          items:
            $ref: '#/components/schemas/V2ProgramUse'
          description: The raters this release’s guideline uses. Empty for a rater.
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/V2ProgramEndpoint'
          description: >-
            The operations this release serves, derived from what its own bundle
            contains. A rater’s release serves its contract and rating. A
            guideline’s release lists none yet.
        latest:
          type: boolean
          description: >-
            True for the latest release: the highest version whose state is
            ready.
        state:
          type: string
          enum:
            - provisioning
            - ready
            - failed
          description: >-
            provisioning while Effective prepares the release to serve; ready
            once it serves; failed if its bundle cannot be served. Only a ready
            release becomes the latest.
        failure:
          type: string
          description: >-
            Why the release failed, when state is failed. Upload a fixed bundle
            and release it.
        metadata:
          type: object
          additionalProperties:
            nullable: true
          description: Release metadata, such as notes.
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
      required:
        - programId
        - releaseVersion
        - bundleId
        - component
        - uses
        - endpoints
        - latest
        - state
        - metadata
        - createdAt
        - createdBy
        - updatedAt
        - updatedBy
      additionalProperties: false
    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: Not currently returned.
          required:
            - code
    V2ProgramUse:
      type: object
      properties:
        alias:
          type: string
          description: The name the guideline gives the rater in its `use` line.
        path:
          type: string
          description: The rater’s source file in the bundle.
        programFingerprint:
          type: string
          description: Fingerprint of the rater’s rating program, compiled alone.
      required:
        - alias
        - path
        - programFingerprint
      additionalProperties: false
    V2ProgramEndpoint:
      type: object
      properties:
        operationId:
          type: string
          description: The operation, by its ID in this reference.
        method:
          type: string
          enum:
            - GET
            - POST
        path:
          type: string
          description: The path to call, with this program and release filled in.
      required:
        - operationId
        - method
        - path
      additionalProperties: false
    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.