AimRank Compliance API

openapi: 3.2.0
info:
  title: AimRank Compliance 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: Compliance
paths:
  /api/v1/compliance/annex-iv-evidence:
    get:
      tags:
      - Compliance
      summary: iCOMPLY Annex IV evidence package
      description: 'Annex IV section-4-shaped evidence bundle for one model or ranking.


        Mirrors the `aimrank_evidence` MCP tool — same response shape, same

        `contract_version`, and now the same visibility rules. Use the MCP

        tool when iCOMPLY''s agent has direct MCP access; use this endpoint

        for any non-MCP integrator (auditor portal, CI smoke, third-party

        DPO tooling).


        Credential is **optional** and travels in a header (`X-API-Key`, or

        `Authorization: Bearer ak_…`), never a query parameter — the URL of

        a compliance request lands in access logs and referrers.'
      operationId: annex_iv_evidence_api_v1_compliance_annex_iv_evidence_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: model_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: L3 reward-model ID to attest
          title: Model Id
        description: L3 reward-model ID to attest
      - name: ranking_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Ranking ID to attest
          title: Ranking Id
        description: Ranking ID to attest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/compliance/audit-chain/verify:
    get:
      tags:
      - Compliance
      summary: Full hash-chain verification
      description: 'Walk the audit-log hash chain and confirm every entry verifies.


        Returns `ok: true` when the chain is intact, `ok: false` plus the

        first-bad row when it isn''t. Cheap to call up to a few thousand

        rows; for tables with millions of rows, pass `max_rows` to bound

        the cost and run a full audit in a background job instead.'
      operationId: verify_audit_chain_api_v1_compliance_audit_chain_verify_get
      parameters:
      - name: max_rows
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1000000
            minimum: 1
          - type: 'null'
          description: Cap the walk for cheap monitoring; omit for full audit
          title: Max Rows
        description: Cap the walk for cheap monitoring; omit for full audit
      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
    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
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key