> ## 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 rater bundle

> Create a release: a version number that names one uploaded bundle of this rater. The highest version is the latest release, which `rateRater` rates; `rateRaterRelease` rates any exact version.

Upload the bundle with `uploadRaterBundle` first. A bundle that was never uploaded for this rater returns 404 `bundle_not_found`.

A release cannot be changed or reused for other content. A version that names another bundle, or has other notes, returns 409 `release_exists`; choose a higher version. To make the new release the latest, use a version above the rater’s `latestReleaseVersion`.

Repeating an identical request is safe. It returns 200 with the existing release. A new release returns 201.

Needs edit permission on the rater.



## OpenAPI

````yaml /openapi.json post /insurance/raters/{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:
  /insurance/raters/{id}/releases:
    post:
      tags:
        - Raters
      summary: Release an uploaded rater bundle
      description: >-
        Create a release: a version number that names one uploaded bundle of
        this rater. The highest version is the latest release, which `rateRater`
        rates; `rateRaterRelease` rates any exact version.


        Upload the bundle with `uploadRaterBundle` first. A bundle that was
        never uploaded for this rater returns 404 `bundle_not_found`.


        A release cannot be changed or reused for other content. A version that
        names another bundle, or has other notes, returns 409 `release_exists`;
        choose a higher version. To make the new release the latest, use a
        version above the rater’s `latestReleaseVersion`.


        Repeating an identical request is safe. It returns 200 with the existing
        release. A new release returns 201.


        Needs edit permission on the rater.
      operationId: createRaterRelease
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: >-
              Your organization’s rater ID, as given when the rater was first
              deployed.
          required: true
          description: >-
            Your organization’s rater ID, as given when the rater was first
            deployed.
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2RaterReleaseCreate'
      responses:
        '200':
          description: The identical release already existed. Nothing changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RaterRelease'
        '201':
          description: The new release.
          headers:
            Location:
              schema:
                type: string
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RaterRelease'
        '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 rater, or are a read-only member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            rater_not_found, or bundle_not_found: the bundle was never uploaded
            for this rater.
          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:
    V2RaterReleaseCreate:
      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
            rater.
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: An uploaded bundle of this rater, from uploadRaterBundle.
        notes:
          type: string
          minLength: 1
          maxLength: 20000
          description: Markdown release notes, stored as metadata.notes.
      required:
        - releaseVersion
        - bundleId
      additionalProperties: false
    V2RaterRelease:
      type: object
      properties:
        raterId:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          description: >-
            Your organization’s rater ID, as given when the rater was first
            deployed.
        releaseVersion:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: SHA-256 identity of the immutable rater bundle.
        latest:
          type: boolean
          description: True for the highest release version.
        metadata:
          type: object
          additionalProperties:
            nullable: true
          description: Bundle metadata, as deployed.
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
      required:
        - raterId
        - releaseVersion
        - bundleId
        - latest
        - 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: >-
                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.