AimRank Calibration API

openapi: 3.2.0
info:
  title: AimRank Calibration API
  description: Ranking-as-a-Service API — Turn binary comparisons into calibrated rankings with Glicko-2, Bradley-Terry, TrueSkill, and cross-domain transfer learning. Includes webhooks, API keys, RLHF exports, and embeddable widgets.
  version: 4.12.0
tags:
- name: Calibration
paths:
  /api/v1/calibration/questionnaire:
    get:
      tags:
      - Calibration
      summary: Get Calibration Questionnaire
      description: 'Get the 8-question calibration questionnaire.


        This questionnaire helps determine optimal starting coefficients

        for a new ranking system based on domain characteristics.'
      operationId: get_calibration_questionnaire_api_v1_calibration_questionnaire_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionnaireResponse'
  /api/v1/calibration/calculate:
    post:
      tags:
      - Calibration
      summary: Calculate Ranking Coefficients
      description: 'Calculate optimal coefficients from questionnaire answers.


        Returns recommended coefficients and a confidence score.

        These coefficients can be applied when creating a ranking.'
      operationId: calculate_ranking_coefficients_api_v1_calibration_calculate_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuestionnaireAnswers'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoefficientCalculationResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/calibration/apply/{ranking_id}:
    post:
      tags:
      - Calibration
      summary: Apply Coefficients To Ranking
      description: 'Apply calculated coefficients to an existing ranking.


        This updates the ranking''s algorithm settings based on

        the questionnaire answers.'
      operationId: apply_coefficients_to_ranking_api_v1_calibration_apply__ranking_id__post
      parameters:
      - name: ranking_id
        in: path
        required: true
        schema:
          type: string
          title: Ranking Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuestionnaireAnswers'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/calibration/presets:
    get:
      tags:
      - Calibration
      summary: List Domain Presets
      description: 'List available domain preset configurations.


        These are pre-configured coefficient sets for common use cases.'
      operationId: list_domain_presets_api_v1_calibration_presets_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/calibration/preset/{ranking_id}/{domain}:
    post:
      tags:
      - Calibration
      summary: Apply Preset To Ranking
      description: 'Apply a domain preset to a ranking.


        Quick way to configure a ranking with recommended settings

        for a specific domain type.'
      operationId: apply_preset_to_ranking_api_v1_calibration_preset__ranking_id___domain__post
      parameters:
      - name: ranking_id
        in: path
        required: true
        schema:
          type: string
          title: Ranking Id
      - name: domain
        in: path
        required: true
        schema:
          type: string
          title: Domain
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/calibration/{ranking_id}:
    get:
      tags:
      - Calibration
      summary: Get Ranking Coefficients
      description: Get current coefficients for a ranking.
      operationId: get_ranking_coefficients_api_v1_calibration__ranking_id__get
      parameters:
      - name: ranking_id
        in: path
        required: true
        schema:
          type: string
          title: Ranking Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/calibration/recalibrate/{ranking_id}:
    post:
      tags:
      - Calibration
      summary: Trigger Recalibration
      description: 'Trigger data-driven recalibration for a ranking.


        Requires at least 100 votes to recalibrate.

        Analyzes prediction accuracy, upset frequency, and

        convergence patterns to optimize coefficients.'
      operationId: trigger_recalibration_api_v1_calibration_recalibrate__ranking_id__post
      parameters:
      - name: ranking_id
        in: path
        required: true
        schema:
          type: string
          title: Ranking Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    QuestionnaireResponse:
      properties:
        title:
          type: string
          title: Title
          default: Set Up Your Ranking
        description:
          type: string
          title: Description
          default: Answer 8 quick questions to customize how your ranking works
        questions:
          items:
            $ref: '#/components/schemas/QuestionResponse'
          type: array
          title: Questions
        total_questions:
          type: integer
          title: Total Questions
          default: 8
        estimated_time:
          type: string
          title: Estimated Time
          default: ~2 minutes
      type: object
      required:
      - questions
      title: QuestionnaireResponse
      description: Full questionnaire response.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    QuestionnaireAnswers:
      properties:
        domain_type:
          type: string
          title: Domain Type
          description: 'Q1: What are you ranking?'
        change_speed:
          type: string
          title: Change Speed
          description: 'Q2: How often rankings change'
        prior_knowledge:
          type: string
          title: Prior Knowledge
          description: 'Q3: How well you know items'
        win_types:
          type: string
          title: Win Types
          description: 'Q4: Are some wins bigger'
        upset_importance:
          type: string
          title: Upset Importance
          description: 'Q5: Underdog value'
        freshness:
          type: string
          title: Freshness
          description: 'Q6: Does activity matter'
        confidence_speed:
          type: string
          title: Confidence Speed
          description: 'Q7: Votes until trusted'
        ties_allowed:
          type: string
          title: Ties Allowed
          description: 'Q8: Can comparisons tie'
      type: object
      required:
      - domain_type
      - change_speed
      - prior_knowledge
      - win_types
      - upset_importance
      - freshness
      - confidence_speed
      - ties_allowed
      title: QuestionnaireAnswers
      description: User answers to the questionnaire.
    QuestionOptionResponse:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
      type: object
      required:
      - value
      - label
      title: QuestionOptionResponse
      description: API response for a question option.
    QuestionResponse:
      properties:
        id:
          type: string
          title: Id
        number:
          type: integer
          title: Number
        text:
          type: string
          title: Text
        description:
          type: string
          title: Description
        type:
          type: string
          title: Type
        options:
          items:
            $ref: '#/components/schemas/QuestionOptionResponse'
          type: array
          title: Options
        required:
          type: boolean
          title: Required
      type: object
      required:
      - id
      - number
      - text
      - description
      - type
      - options
      - required
      title: QuestionResponse
      description: API response for a question.
    CoefficientCalculationResult:
      properties:
        coefficients:
          additionalProperties: true
          type: object
          title: Coefficients
        domain_type:
          type: string
          title: Domain Type
        calibration_source:
          type: string
          title: Calibration Source
          default: questionnaire
        confidence_score:
          type: number
          title: Confidence Score
          description: 0-1 confidence in calibration
        recommendations:
          items:
            type: string
          type: array
          title: Recommendations
        summary:
          type: string
          title: Summary
          description: Human-readable summary of the calibration.
          readOnly: true
      type: object
      required:
      - coefficients
      - domain_type
      - confidence_score
      - recommendations
      - summary
      title: CoefficientCalculationResult
      description: Result of coefficient calculation from questionnaire.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key