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

# OpenAPI specification

> Download the machine-readable OpenAPI 3.1.0 contract for the Idunox Platform API.

Returns the full OpenAPI 3.1.0 specification for the Idunox Platform API. No authentication required.

| Format | Path                |
| ------ | ------------------- |
| JSON   | `GET /openapi.json` |
| YAML   | `GET /openapi.yaml` |

Use the specification to generate client SDKs or import into API testing tools.

## Example requests

```bash theme={null}
curl https://api.idunox.com/openapi.json
curl https://api.idunox.com/openapi.yaml
```


## OpenAPI

````yaml GET /openapi.json
openapi: 3.1.0
info:
  title: IduScore Partner & Platform API
  description: >-
    Partner-facing JSON API for de-identified clinical submissions (canonical
    Type A, not FHIR at ingestion).


    **Authentication:** Send `X-Api-Key: <key>` **or** `Authorization: Bearer
    <key>` on every `/v1/*` request (except preflight `OPTIONS`).


    **Writes (`POST`):** Client MUST send non-empty `x-correlation-id` and
    `Idempotency-Key`. The server does not synthesize these from the request id.


    **Tenant scope:** Credentials resolve to a tenant; all IDs are tenant-scoped
    (cross-tenant access returns `404` where applicable).


    **Request id:** Responses may echo `x-request-id` when the client sent it;
    otherwise the server generates one (see error envelope `requestId`).


    **Partner responses:** Read APIs return **IduScore wellbeing** language only
    — stable `wellbeing.*` outcome ids,

    plain-English labels, and optional `notices[].message` lines (no internal
    warning codes or model identifiers).

    Use **`GET /openapi.yaml`** for request/response examples aligned with this
    contract.



    ---

    **Merged spec (this file):** includes **Platform** and **Diagnostics** paths
    from the service implementation in addition to the **Type A** `/v1` product
    routes. The slimmer `type-a-partner-v1.*` files are the same contract for
    submissions, jobs, and results.
  version: 0.1.0
  license:
    name: Proprietary
servers:
  - url: https://api.idunox.com
    description: Production partner API (documented base URL for examples and playground)
security: []
tags:
  - name: Submissions
    description: Ingestion and submission reads
  - name: Jobs
    description: Processing job status
  - name: Results
    description: Inference / scoring results
  - name: Webhooks
    description: >
      Outbound HTTPS callbacks the platform may POST to a URL you register (not
      paths on the IduScore Partner API;

      `/_reference/...` entries document payload and headers for your
      implementer only).
  - name: Platform
    description: >-
      Liveness, readiness, and OpenAPI document discovery. **No API key**
      required.
  - name: Diagnostics
    description: >-
      Validates the same **partner API key** and (for `POST`) write headers as
      other `/v1` routes. Returns `204` when valid.
paths:
  /openapi.json:
    get:
      tags:
        - Platform
      summary: OpenAPI specification (JSON) — from disk when build has emitted it
      description: >-
        On a **running** server, returns the prebuilt `openapi.json` (merged)
        when present; otherwise the server derives JSON from the Type A YAML
        only.
      operationId: getOpenapiJson
      parameters:
        - $ref: '#/components/parameters/HeaderRequestIdOptional'
      responses:
        '200':
          description: OpenAPI 3.1.0 document (JSON object)
          content:
            application/json:
              schema:
                type: object
                description: OpenAPI document
      security: []
components:
  parameters:
    HeaderRequestIdOptional:
      name: x-request-id
      in: header
      required: false
      schema:
        type: string
      description: Optional; echoed when possible. Server generates when absent.

````