HLA-Verify Translate API

openapi: 3.2.0
info:
  title: HLA-Verify Translate API
  version: 1.0.0
  description: 'Deterministic validation of HLA nomenclature and donor-recipient match arithmetic against IPD-IMGT/HLA 3.66.0. No LLM; nothing stored. What to send: allele names, typing strings, GL strings and report text about HLA typing. What never to send: patient identifiers of any kind (names, medical record numbers, dates of birth, accession or case identifiers, other patient details). The service neither needs nor wants them, request bodies are processed in memory and never stored, and de-identifying before sending is the caller''s responsibility. This is a nomenclature and reference-release checker: not a diagnostic aid, not clinical decision support, and it does not recommend a donor. Limits are a daily call quota plus a per-call batch cap, both per tier: free 100 calls/day per IP and 250 typings per /v1/normalize call, free_key 1,000/250 (the instant self-serve key), starter 500/250, lab 10,000/5,000, scale 1,000,000/5,000, enterprise uncapped/5,000, academic 10,000/5,000 (hand-issued to accredited institutions, never sold); ''pro'' is the legacy name for ''lab''. Quotas reset at UTC midnight and every billable response carries x-hla-verify-daily-limit, -daily-remaining, -daily-reset and -max-typings. /healthz, /docs, /openapi.json, /pricing, /v1/checkout, /v1/beta-signup, /v1/research-access, /v1/keys, /v1/report and /v1/usage are not billable. Per-key usage reporting: GET /v1/usage returns the caller''s own calls and units for today/7d/30d, by endpoint and by status, plus the tier''s daily quota; cached 60s per key; 401 without a key. Free for anyone: anonymous access stays open, and anyone can get a free API key instantly (1,000 calls/day, 250 typings per call) at https://hlaverify.com/research or with POST /v1/research-access. Verified labs that need more can have the Lab tier (10,000 calls/day) by request. Nothing is for sale. Enterprise and self-hosting: hello@hlaverify.com.'
  contact:
    email: hello@hlaverify.com
    url: https://hlaverify.com
servers:
- url: https://api.hlaverify.com
- url: https://hlaverify.com
security:
- {}
- ApiKey: []
tags:
- name: Translate
paths:
  /v1/translate:
    post:
      summary: Translate allele names from one IPD-IMGT/HLA release to another
      description: 'Each name, as written in release `from` (or any release when omitted), is mapped through its HLA ID to its name in `to` (default: the current release). Statuses: unchanged, renamed, deleted (reason, successor and the successor''s name in `to`), not_yet_named, not_in_from_release, ambiguous (each allele listed), unknown. Batch size per tier as /v1/normalize; one billable call.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - names
              properties:
                names:
                  type: array
                  items:
                    type: string
                  example:
                  - A*24:02:03
                  - C*12:139
                  - A*0101
                from:
                  type: string
                  example: 3.40.0
                  description: An IPD-IMGT/HLA release this history covers (GET /v1/releases).
                to:
                  type: string
                  example: 3.40.0
                  description: An IPD-IMGT/HLA release this history covers (GET /v1/releases).
      responses:
        '200':
          description: one row per name, plus counts by status
        '422':
          description: names missing or over the tier's batch size, or a release not in the history
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Translate
      operationId: postV1Translate
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      properties:
        detail:
          type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key