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

# Rate with a used rater of a program’s latest release

> Rate one submission with a rater that the latest release’s guideline entry uses, as [Rate with a used rater of a program release](/api-reference/your-programs/rate-with-a-used-rater-of-a-program-release) does. Without a version in the path, the call answers on the program’s latest release, resolved once; the response’s `releaseVersion` and `bundleId` name what answered. A new release changes what this operation rates.



## OpenAPI

````yaml /openapi.json post /rsl/{id}/{alias}/rate
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}/{alias}/rate:
    post:
      tags:
        - Your programs
      summary: Rate with a used rater of a program’s latest release
      description: >-
        Rate one submission with a rater that the latest release’s guideline
        entry uses, as [Rate with a used rater of a program
        release](/api-reference/your-programs/rate-with-a-used-rater-of-a-program-release)
        does. Without a version in the path, the call answers on the program’s
        latest release, resolved once; the response’s `releaseVersion` and
        `bundleId` name what answered. A new release changes what this operation
        rates.
      operationId: rateProgramRater
      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
        - schema:
            type: string
            pattern: ^[A-Za-z_][A-Za-z0-9_]{0,127}$
            description: >-
              A rater the program’s guideline entry uses, by the alias of its
              `use` line (`use ts = "rater.rsl"` is `ts`). The release’s `uses`
              lists them.
          required: true
          description: >-
            A rater the program’s guideline entry uses, by the alias of its
            `use` line (`use ts = "rater.rsl"` is `ts`). The release’s `uses`
            lists them.
          name: alias
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ProgramRateRequest'
      responses:
        '200':
          description: >-
            The rating result, timings and the exact release and bundle that
            rated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProgramRateResult'
        '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: The user permission is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            program_not_found, release_not_found, or alias_not_found: the
            release’s entry uses no rater by that alias.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            wrong_component: the release’s entry does not answer this call, for
            example rate on a guideline entry; alias_unavailable: the release
            records no engine that calls its raters by alias;
            contract_unavailable: a rater entry has no stored contract.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: The inputs exceed 1 MiB.
          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'
        '422':
          description: invalid_inputs, business_rejection or evaluation_failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Too many requests, or rater_overloaded. 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: >-
            rate_timeout, rater_unavailable or a dependency is unavailable.
            Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ProgramRateRequest:
      type: object
      properties:
        inputs:
          type: object
          additionalProperties:
            nullable: true
          description: >-
            Engine input: one key per root record, for example `{"Policy":
            {...}}`.
        detailed:
          type: boolean
          description: >-
            When true, return computed calculation values as well as declared
            outcomes. Omit or set false to return only what the contract’s
            outputSchema describes.
      required:
        - inputs
      additionalProperties: false
    V2ProgramRateResult:
      type: object
      properties:
        executionId:
          type: string
          description: ID of the saved execution. Failed ratings save one too.
        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
          description: >-
            The release that answered. A call without a version answers on the
            latest.
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: SHA-256 identity of the bundle that answered.
        alias:
          type: string
          nullable: true
          description: >-
            The used rater that rated, by its alias; null when a rater entry
            rated.
        programFingerprint:
          type: string
          description: >-
            Fingerprint of the rating program that rated: the entry’s, or the
            used rater’s.
        lane:
          type: string
          enum:
            - worker
            - local
          description: >-
            Where the rating ran. `worker`: the Worker that runs the engine the
            bundle carries. `local`: the API’s own rslc engine.
        result:
          type: object
          additionalProperties:
            nullable: true
          description: >-
            Outputs keyed by root record. The contract’s outputSchema describes
            them. The engine computes in exact decimals; the API returns them as
            JSON numbers with 64-bit float precision, about 15 significant
            digits.
        timings:
          type: object
          properties:
            totalMs:
              type: number
              minimum: 0
            coldStartMs:
              type: number
              minimum: 0
            evaluateMs:
              type: number
              minimum: 0
            workerMs:
              type: number
              minimum: 0
            materializeMs:
              type: number
              minimum: 0
          required:
            - totalMs
            - workerMs
          additionalProperties: false
          description: >-
            Milliseconds spent on this rating. coldStartMs is present only on a
            cold start.
      required:
        - executionId
        - programId
        - releaseVersion
        - bundleId
        - alias
        - programFingerprint
        - result
        - timings
      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
    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.