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

# Get a program

> Get one of your programs, its latest release and the operations that release serves.

`endpoints` lists those operations with their paths. Effective derives them from the bundle: a release of a rater program rates at the rater routes. A release of a program with a guideline entry lists none yet; the rater routes answer 409 `wrong_component` for it.

An archived or unknown program returns 404 `program_not_found`.



## OpenAPI

````yaml /openapi.json get /rsl/{id}
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}:
    get:
      tags:
        - Your programs
      summary: Get a program
      description: >-
        Get one of your programs, its latest release and the operations that
        release serves.


        `endpoints` lists those operations with their paths. Effective derives
        them from the bundle: a release of a rater program rates at the rater
        routes. A release of a program with a guideline entry lists none yet;
        the rater routes answer 409 `wrong_component` for it.


        An archived or unknown program returns 404 `program_not_found`.
      operationId: getProgram
      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
      responses:
        '200':
          description: The program.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Program'
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: The user permission is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: program_not_found or release_not_found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Too many requests. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2Program:
      allOf:
        - $ref: '#/components/schemas/V2ProgramListItem'
        - type: object
          properties:
            uses:
              type: array
              items:
                $ref: '#/components/schemas/V2ProgramUse'
              description: >-
                The raters the latest release’s guideline uses. Empty for a
                rater.
            endpoints:
              type: array
              items:
                $ref: '#/components/schemas/V2ProgramEndpoint'
              description: >-
                The operations the latest release serves, derived from what its
                bundle contains. Empty before the first release.
          required:
            - uses
            - endpoints
          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
    V2ProgramListItem:
      type: object
      properties:
        id:
          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.
        component:
          type: string
          nullable: true
          enum:
            - rater
            - guideline
            - null
          description: >-
            The entry component of the latest release, or null before the first
            release.
        latestReleaseVersion:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
          description: Highest ready release version, or null before the first release.
        bundleId:
          type: string
          nullable: true
          pattern: ^[a-f0-9]{64}$
          description: Bundle of the latest release, or null before the first release.
        programFingerprint:
          type: string
          nullable: true
          description: >-
            Fingerprint of the latest released program, or null before the first
            release.
      required:
        - id
        - component
        - latestReleaseVersion
        - bundleId
        - programFingerprint
      additionalProperties: false
    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.