> ## Documentation Index
> Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the input and output schemas of a program version

> Get the rating engine’s input and output JSON schemas for a specific program version.

These schemas describe engine inputs and results. A Relativities book uses a separate schema, and this request does not run the program’s preparation code.

Build the rating request's `inputs` object to match `inputSchema`, including its root record names. Interpret returned premiums with `outputSchema` and the program's documented term and coverage basis.

Requires your organization’s permission to run or download the program, plus your `raters:view` permission. Effective example programs require only `raters:view`.



## OpenAPI

````yaml /openapi.json get /insurance/rating-programs/{id}/versions/{version}/contract
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.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs/{id}/versions/{version}/contract:
    get:
      tags:
        - Rating programs
      summary: Get the input and output schemas of a program version
      description: >-
        Get the rating engine’s input and output JSON schemas for a specific
        program version.


        These schemas describe engine inputs and results. A Relativities book
        uses a separate schema, and this request does not run the program’s
        preparation code.


        Build the rating request's `inputs` object to match `inputSchema`,
        including its root record names. Interpret returned premiums with
        `outputSchema` and the program's documented term and coverage basis.


        Requires your organization’s permission to run or download the program,
        plus your `raters:view` permission. Effective example programs require
        only `raters:view`.
      operationId: getRatingProgramVersionContract
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
          required: true
          name: version
          in: path
      responses:
        '200':
          description: >-
            Exact engine input/output schemas; native inputs are distinct from
            the Program book schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  programId:
                    type: string
                  version:
                    type: number
                  engineBundleId:
                    type: string
                  inputSchema:
                    type: object
                    nullable: true
                    additionalProperties:
                      nullable: true
                  outputSchema:
                    type: object
                    nullable: true
                    additionalProperties:
                      nullable: true
                required:
                  - programId
                  - version
                  - engineBundleId
                  - inputSchema
                  - outputSchema
                additionalProperties: false
        '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: Program entitlement and user permission are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Program, version or package not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Stored bundle identity differs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Input exceeds the size limit.
          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. violations
            lists each failed input constraint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rating capacity unavailable; honor Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    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.
            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.