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

# Upload a program bundle

> Upload a program bundle ZIP, as `rslc export` builds it from one entry file, as the request body. Effective checks the bundle, loads it once and stores it. Uploading changes nothing that serves: send the returned `bundleId` to [Release an uploaded program bundle](/api-reference/your-programs/release-an-uploaded-program-bundle) to serve it.

The response states the program’s entry `component` and, for a guideline entry, the raters it `uses`.

The first upload to a new ID creates the program with that ID. A program keeps its entry component: every bundle of one ID has the `component` of its first upload, and an upload with another entry component returns 422 `invalid_bundle` with the reason `wrong_component`. To put a guideline in front of a rater program, upload the program with the guideline entry under a new ID. An archived program returns 404 `program_not_found`.

Send `Content-Type: application/zip`, at most 128 MiB. The bundle ID comes from the bundle’s content, so a rebuild usually gets a new ID.

Uploading the same content again is safe: it returns 200 with `alreadyUploaded: true`. A new upload returns 201.

Needs edit permission on the program. A new program needs permission to edit raters in your organization.



## OpenAPI

````yaml /openapi.json post /rsl/{id}/uploads
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}/uploads:
    post:
      tags:
        - Your programs
      summary: Upload a program bundle
      description: >-
        Upload a program bundle ZIP, as `rslc export` builds it from one entry
        file, as the request body. Effective checks the bundle, loads it once
        and stores it. Uploading changes nothing that serves: send the returned
        `bundleId` to [Release an uploaded program
        bundle](/api-reference/your-programs/release-an-uploaded-program-bundle)
        to serve it.


        The response states the program’s entry `component` and, for a guideline
        entry, the raters it `uses`.


        The first upload to a new ID creates the program with that ID. A program
        keeps its entry component: every bundle of one ID has the `component` of
        its first upload, and an upload with another entry component returns 422
        `invalid_bundle` with the reason `wrong_component`. To put a guideline
        in front of a rater program, upload the program with the guideline entry
        under a new ID. An archived program returns 404 `program_not_found`.


        Send `Content-Type: application/zip`, at most 128 MiB. The bundle ID
        comes from the bundle’s content, so a rebuild usually gets a new ID.


        Uploading the same content again is safe: it returns 200 with
        `alreadyUploaded: true`. A new upload returns 201.


        Needs edit permission on the program. A new program needs permission to
        edit raters in your organization.
      operationId: uploadProgram
      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/zip:
            schema:
              type: string
              format: binary
              description: The bundle ZIP.
      responses:
        '200':
          description: The program already had this content. Nothing changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramUpload'
        '201':
          description: The bundle is stored and ready to release.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramUpload'
        '400':
          description: Invalid request, such as an empty body.
          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: the program is archived.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            bundle_conflict: stored content with this bundle ID differs from the
            upload, or the program’s storage changed during the upload; retry
            once.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: >-
            The ZIP exceeds 128 MiB, or a file in it exceeds its extracted size
            limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: The request body is not application/zip.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: >-
            invalid_bundle: the bundle failed validation. details[0].message
            names the failed check, for example digest_mismatch or
            bundle_load_failed.
          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:
    V2ProgramUpload:
      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.
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: >-
            SHA-256 identity of the uploaded bundle. Pass it to
            createProgramRelease to serve it.
        programFingerprint:
          type: string
          description: Fingerprint of the bundle’s entry program.
        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 the bundle’s guideline uses. Empty for a rater.
        uploadedAt:
          type: string
          format: date-time
          description: When this content was first uploaded.
        uploadedBy:
          type: string
          description: Who first uploaded this content.
        alreadyUploaded:
          type: boolean
          description: >-
            True when this program already had this exact content. Nothing
            changed.
        latestReleaseVersion:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
          description: >-
            The program’s latest release version (its highest ready release), or
            null before its first release. The next release needs a higher
            version to become the latest.
      required:
        - programId
        - bundleId
        - programFingerprint
        - component
        - uses
        - uploadedAt
        - uploadedBy
        - alreadyUploaded
        - latestReleaseVersion
      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
    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.