{ "openapi": "3.1.0", "info": { "title": "Animica Health", "version": "1.0.0", "summary": "Verifiable AI and compute infrastructure for healthcare.", "description": "Animica Health runs healthcare AI and data workloads through controlled compute environments and\nreturns a cryptographically signed execution receipt for every completed workload.\n\n## The one thing to understand first\n\nEvery workload has an `execution_class`. `HEALTH_SECURE` work runs ONLY on providers an operator has\nexplicitly approved. It is never routed to the public Animica network, never to a browser worker,\nnever to an unapproved machine — and it is never downgraded when secure capacity is unavailable.\nA request with no secure capacity fails with `503 SECURE_CAPACITY_UNAVAILABLE`. That failure is the\nguarantee.\n\nA PHI-capable operation with no stated `execution_class` defaults to `HEALTH_SECURE`. The unsafe\nanswer always requires an explicit statement.\n\n## What this is not\n\nThis is infrastructure. It does not diagnose disease, prescribe treatment, replace clinicians, or\nprovide medical advice. Animica claims no HIPAA, SOC 2, HITRUST or FDA certification; see\nhttps://animica.dev/health/compliance for the technical controls that exist and the work that would be required\nto obtain any such certification.\n\n## Authentication\n\nSend `Authorization: Bearer ahk_...` or `X-Api-Key: ahk_...`. No wallet, no cryptocurrency and no\nblockchain knowledge is required to use this API.", "contact": { "name": "Animica Health", "url": "https://animica.dev/health" } }, "servers": [ { "url": "https://animica.dev" } ], "x-policy-version": "ahp-2026.08.31", "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-residencies": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "x-error-codes": { "INVALID_REQUEST": 400, "INVALID_FHIR": 400, "PAYLOAD_TOO_LARGE": 413, "POLICY_VIOLATION": 403, "MODEL_NOT_ALLOWED": 403, "AUTHORIZATION_FAILED": 401, "FORBIDDEN": 403, "NOT_FOUND": 404, "METHOD_NOT_ALLOWED": 405, "CONFLICT": 409, "RATE_LIMITED": 429, "QUOTA_EXCEEDED": 429, "RECEIPT_INVALID": 400, "SECURE_CAPACITY_UNAVAILABLE": 503, "RESIDENCY_CAPACITY_UNAVAILABLE": 503, "PROVIDER_NOT_APPROVED": 503, "MODEL_UNAVAILABLE": 503, "SERVICE_UNAVAILABLE": 503, "EXECUTION_TIMEOUT": 504, "EXECUTION_FAILED": 502 }, "tags": [ { "name": "Service", "description": "Status, sandbox and onboarding" }, { "name": "Jobs", "description": "Submit and track workloads" }, { "name": "Inference", "description": "Model execution" }, { "name": "FHIR", "description": "Validation and transformation" }, { "name": "Terminology", "description": "Search and crosswalk" }, { "name": "Privacy", "description": "De-identification assistance and deletion" }, { "name": "Documents", "description": "Structure and classification" }, { "name": "Research", "description": "Literature and clinical trials" }, { "name": "Models", "description": "Registry and evaluation" }, { "name": "Receipts", "description": "Execution receipts and verification" }, { "name": "Providers", "description": "Compute providers and approval" }, { "name": "Organization", "description": "Organizations, keys and RBAC" }, { "name": "Billing", "description": "Usage and invoices" }, { "name": "Audit", "description": "Security event log" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "An Animica Health API key (ahk_...)" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } }, "schemas": { "Error": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } }, "Receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } } } }, "paths": { "/health/v1/status": { "get": { "operationId": "getStatus", "tags": [ "Service" ], "summary": "Service status and live capacity", "description": "Unauthenticated. Reports live HEALTH_SECURE capacity, the receipt signing algorithm actually in use, and the policy version.", "responses": { "200": { "description": "status", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/health/v1/openapi.json": { "get": { "operationId": "getOpenApi", "tags": [ "Service" ], "summary": "This document", "responses": { "200": { "description": "OpenAPI 3.1" } } } }, "/health/v1/sandbox": { "get": { "operationId": "getSandbox", "tags": [ "Service" ], "summary": "Synthetic fixtures and runnable examples", "responses": { "200": { "description": "fixtures" } } } }, "/health/v1/sandbox/signup": { "post": { "operationId": "sandboxSignup", "tags": [ "Service" ], "summary": "Self-serve a sandbox organization and API key", "description": "No card, no wallet, no cryptocurrency. Returns a HEALTH_PUBLIC-only key immediately.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } } } }, "responses": { "201": { "description": "organization and key" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/access/request": { "post": { "operationId": "requestAccess", "tags": [ "Service" ], "summary": "Request healthcare onboarding (HEALTH_SECURE / BAA)", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "company", "contact_email", "use_case" ], "properties": { "company": { "type": "string" }, "contact_email": { "type": "string" }, "use_case": { "type": "string" }, "plan": { "type": "string" }, "expected_volume": { "type": "string" }, "regions": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "202": { "description": "received" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs": { "post": { "operationId": "createJob", "tags": [ "Jobs" ], "summary": "Submit a workload as a job", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "input": { "type": "object", "description": "the operation-specific request body" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "operation": "fhir.validate", "execution_class": "HEALTH_PUBLIC", "input": { "resource": { "resourceType": "Observation", "code": { "text": "Glucose" } } } } } } }, "responses": { "201": { "description": "the job, its result and its receipt" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } }, "get": { "operationId": "listJobs", "tags": [ "Jobs" ], "summary": "List this organization's jobs", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "jobs" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs/{id}": { "get": { "operationId": "getJob", "tags": [ "Jobs" ], "summary": "Job status and lifecycle events", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "job" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs/{id}/cancel": { "post": { "operationId": "cancelJob", "tags": [ "Jobs" ], "summary": "Cancel a non-terminal job", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "cancelled" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs/{id}/result": { "get": { "operationId": "getJobResult", "tags": [ "Jobs" ], "summary": "Stored result (only when retention permits)", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "result" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs/{id}/receipt": { "get": { "operationId": "getJobReceipt", "tags": [ "Receipts" ], "summary": "The execution receipt for a job", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "receipt", "content": { "application/json": { "schema": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/jobs/{id}/review": { "post": { "operationId": "reviewJob", "tags": [ "Jobs" ], "summary": "Advance the human-review workflow state", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "review state" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/inference": { "post": { "operationId": "runInference", "summary": "Run a healthcare model", "description": "Executes the named model in the requested execution class. HEALTH_SECURE runs only on an approved secure provider and is never downgraded.", "tags": [ "Inference" ], "x-operation": "inference", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": false, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string" }, "system": { "type": "string" }, "temperature": { "type": "number" }, "max_tokens": { "type": "integer" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "input": "Summarise the medication list.", "execution_class": "HEALTH_SECURE" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/batch": { "post": { "operationId": "runBatch", "summary": "Run one operation over many items", "description": "Every item inherits the parent job's policy; a batch cannot mix execution classes.", "tags": [ "Inference" ], "x-operation": "batch", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": false, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "inference", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "items": { "type": "array", "items": { "type": "object" } }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "operation": "fhir.validate", "execution_class": "HEALTH_PUBLIC", "items": [ { "resource": { "resourceType": "Patient" } } ] } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/fhir/validate": { "post": { "operationId": "validateFhir", "summary": "Validate FHIR R4 resources", "description": "Structural validation: required elements, cardinality, primitive datatypes, required-binding codes, reference syntax and target types, and named invariants. It is NOT profile conformance and the response says which checks ran and which did not.", "tags": [ "FHIR" ], "x-operation": "fhir.validate", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object" }, "resources": { "type": "array", "items": { "type": "object" } }, "profile": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "execution_class": "HEALTH_PUBLIC", "resource": { "resourceType": "Observation", "code": { "text": "Glucose" } } } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/fhir/transform": { "post": { "operationId": "transformFhir", "summary": "Transform between declared representations", "description": "Deterministic, declared mappings only. Nothing is inferred: every produced element traces to a source field and every unmapped source field is reported.", "tags": [ "FHIR" ], "x-operation": "fhir.transform", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "transform": { "type": "string" }, "input": {}, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "execution_class": "HEALTH_PUBLIC", "transform": "lab.row-to-observation", "input": { "patient_id": "p1", "code": "LB-1000", "value": "96", "unit": "mg/dL" } } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/terminology/search": { "post": { "operationId": "searchTerminology", "summary": "Search loaded terminology", "description": "Answers only from vocabularies loaded on this deployment. Animica redistributes no licensed terminology; an unloaded system returns 503 naming the dataset, never an empty result.", "tags": [ "Terminology" ], "x-operation": "terminology.search", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "system": { "type": "string" }, "limit": { "type": "integer" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "query": "glucose", "system": "animica-demo" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/terminology/map": { "post": { "operationId": "mapTerminology", "summary": "Crosswalk a code between systems", "description": "Returns the equivalence the source map declared and never upgrades it. An unmatched code is reported unmatched, not mapped to the nearest guess.", "tags": [ "Terminology" ], "x-operation": "terminology.map", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "code": "DX-B200", "from": "animica-demo", "to": "animica-demo-alt" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/deidentify": { "post": { "operationId": "deidentify", "summary": "De-identification ASSISTANCE", "description": "Assistance, not a legal determination. Does not implement HIPAA Safe Harbor and is not an Expert Determination; every response says so and enumerates residual risk.", "tags": [ "Privacy" ], "x-operation": "deidentify", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": false, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "resource": { "type": "object" }, "strategy": { "type": "string", "enum": [ "REDACT", "TOKENIZE", "PSEUDONYMIZE" ] }, "categories": { "type": "array", "items": { "type": "string" } }, "token_secret": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "execution_class": "HEALTH_SECURE", "strategy": "REDACT", "text": "Patient: A B, MRN 12345" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/documents/structure": { "post": { "operationId": "structureDocument", "summary": "Sections, fields, timeline, abbreviations", "tags": [ "Documents" ], "x-operation": "documents.structure", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "execution_class": "HEALTH_SECURE", "text": "DISCHARGE SUMMARY\n\nCHIEF COMPLAINT:\nChest pain" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/documents/classify": { "post": { "operationId": "classifyDocument", "summary": "Document type with evidence", "tags": [ "Documents" ], "x-operation": "documents.classify", "x-phi-allowed": true, "x-execution-classes": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "x-default-execution-class": "HEALTH_SECURE", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ], "description": "A hard boundary. If no approved provider is online in the region, the request fails with 503 RESIDENCY_CAPACITY_UNAVAILABLE rather than running elsewhere." }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ], "description": "none = nothing is persisted; the result exists only in the response. transient = encrypted at rest for a short window. customer_defined = encrypted at rest for retention_seconds." }, "retention_seconds": { "type": "integer" }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "model_version": { "type": "integer", "description": "pin an exact version. Omitted, the latest is used — and its exact hash is in the receipt either way." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." }, "review_required": { "type": "boolean", "description": "start the job in review state REVIEW_REQUIRED for a human-review workflow." } } }, "example": { "execution_class": "HEALTH_SECURE", "text": "RADIOLOGY REPORT\n\nFINDINGS:\nThe lungs are clear." } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/literature/search": { "post": { "operationId": "searchLiterature", "summary": "Search PubMed", "tags": [ "Research" ], "x-operation": "literature.search", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "limit": { "type": "integer" }, "from_year": { "type": "integer" }, "to_year": { "type": "integer" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "query": "sepsis early warning score", "limit": 5 } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/literature/summarize": { "post": { "operationId": "summarizeLiterature", "summary": "Claim-labelled literature summary", "description": "Default mode is extractive: every sentence is copied verbatim from a retrieved abstract and carries its PMID, so nothing can be fabricated. Optional synthesis mode deletes any sentence citing a PMID outside the retrieved set and labels the rest SOURCE_SUPPORTED / MODEL_INFERENCE / UNKNOWN.", "tags": [ "Research" ], "x-operation": "literature.summarize", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "pmids": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string", "enum": [ "extractive", "synthesis" ] }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "query": "metformin cardiovascular outcomes", "mode": "extractive" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/trials/search": { "post": { "operationId": "searchTrials", "summary": "Search ClinicalTrials.gov", "tags": [ "Research" ], "x-operation": "trials.search", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "condition": { "type": "string" }, "intervention": { "type": "string" }, "status": { "type": "string" }, "phase": { "type": "string" }, "lat": { "type": "number" }, "lon": { "type": "number" }, "radius_km": { "type": "number" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "condition": "type 2 diabetes", "status": "RECRUITING", "limit": 5 } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/trials/summarize": { "post": { "operationId": "summarizeTrials", "summary": "Structured comparison across trials", "tags": [ "Research" ], "x-operation": "trials.summarize", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nct_ids": { "type": "array", "items": { "type": "string" } }, "condition": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "condition": "type 2 diabetes" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/trials/{nct_id}": { "get": { "operationId": "getTrial", "tags": [ "Research" ], "summary": "One trial, with structured eligibility criteria", "description": "Criteria are STRUCTURED, never evaluated against a person. This service does not determine anyone's eligibility.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "nct_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "trial" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/models/evaluate": { "post": { "operationId": "evaluateModel", "summary": "Run an evaluation suite against a model artifact", "tags": [ "Models" ], "x-operation": "model.evaluate", "x-phi-allowed": false, "x-execution-classes": [ "HEALTH_PUBLIC" ], "x-default-execution-class": "HEALTH_PUBLIC", "x-x402-purchasable": true, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Replay-safe: the same key on the same organization returns the original job rather than creating a second one." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "suite": { "type": "string" }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ], "description": "HEALTH_SECURE for anything that may contain PHI. Omitted, a PHI-capable operation defaults to HEALTH_SECURE — the conservative answer. HEALTH_SECURE work is NEVER downgraded to public compute: with no secure capacity the request fails with 503 SECURE_CAPACITY_UNAVAILABLE." }, "model": { "type": "string", "description": "model_id from GET /health/v1/models. Omitted, the default model for the operation is used and named in the receipt." }, "anchor": { "type": "boolean", "description": "anchor a digest of the receipt to the Animica chain. No payload, no commitment and no identifier is ever anchored." } } }, "example": { "suite": "fhir.validate.correctness" } } } }, "responses": { "200": { "description": "the workload completed and produced a signed execution receipt", "content": { "application/json": { "schema": { "type": "object", "properties": { "job_id": { "type": "string" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "model": { "type": "object" }, "output": { "description": "operation-specific result" }, "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "commitment_salt": { "type": "string", "description": "returned ONCE. Keep it with your copy of the input and output to prove later that this receipt is about them." }, "usage": { "type": "object" } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/provenance/verify": { "post": { "operationId": "verifyReceipt", "tags": [ "Receipts" ], "summary": "Verify a receipt — free, unauthenticated", "description": "Returns a per-property verdict, not a boolean: signature, issuance, input commitment, output commitment, model identity and chain anchor are each reported as ok / failed / not_checked / unavailable. A verifier that could not run is never reported as a forgery.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "receipt": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } }, "input": {}, "output": {}, "commitment_salt": { "type": "string" } } } } } }, "responses": { "200": { "description": "verdict" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/provenance/public-key": { "get": { "operationId": "getPublicKey", "tags": [ "Receipts" ], "summary": "The ML-DSA-65 public key receipts are signed with", "responses": { "200": { "description": "public key" } } } }, "/health/v1/receipts": { "get": { "operationId": "listReceipts", "tags": [ "Receipts" ], "summary": "This organization's receipts", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "receipts" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/receipts/{id}": { "get": { "operationId": "getReceipt", "tags": [ "Receipts" ], "summary": "One receipt", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "receipt", "content": { "application/json": { "schema": { "type": "object", "description": "A Health Execution Receipt (AHR1). Carries commitments and metadata only — never input, output, or any identifier of any person.", "required": [ "version", "receipt_id", "job_id", "timestamp", "execution_class", "model_id", "model_version", "model_hash", "input_commitment", "output_commitment", "policy_version", "receipt_signature" ], "properties": { "version": { "type": "string", "const": "AHR1" }, "receipt_id": { "type": "string" }, "job_id": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "operation": { "type": "string", "enum": [ "inference", "batch", "fhir.validate", "fhir.transform", "terminology.search", "terminology.map", "deidentify", "documents.structure", "documents.classify", "literature.search", "literature.summarize", "trials.search", "trials.get", "trials.summarize", "model.evaluate", "provenance.verify" ] }, "model_id": { "type": "string" }, "model_version": { "type": "integer" }, "model_hash": { "type": "string", "description": "SHA-256 of the exact artifact that executed" }, "input_commitment": { "type": "string", "description": "ahc1: — HMAC-SHA256(salt, canonical(input)). The salt is returned to you once and is never in the receipt." }, "output_commitment": { "type": "string" }, "commitment_alg": { "type": "string" }, "policy_version": { "type": "string" }, "residency": { "type": "string", "enum": [ "ANY", "US", "EU", "CUSTOMER_PRIVATE" ] }, "retention": { "type": "string", "enum": [ "none", "transient", "customer_defined" ] }, "provider_attestation": { "type": "object", "properties": { "provider_id": { "type": "string" }, "provider_class": { "type": "string", "enum": [ "HEALTH_PUBLIC", "HEALTH_SECURE" ] }, "region": { "type": "string" }, "isolation": { "type": "string" }, "attestation_kind": { "type": "string" }, "attestation_verified": { "type": "boolean", "description": "false in this build: no hardware attestation document is cryptographically verified. The kind is what the operator asserted." } } }, "execution": { "type": "object", "properties": { "started_at": { "type": "string" }, "completed_at": { "type": "string" }, "duration_ms": { "type": "integer" } } }, "sandbox": { "type": "boolean" }, "issuer": { "type": "string" }, "receipt_signature": { "type": "object", "properties": { "alg": { "type": "string", "description": "ml_dsa_65 (post-quantum, third-party verifiable) or HMAC-SHA256 (issuer-verifiable only)" }, "signature": { "type": "string" }, "public_key": { "type": "string" }, "key_id": { "type": "string" }, "verifiable_by": { "type": "string", "enum": [ "anyone", "issuer_only" ] } } } } } } } }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/models": { "get": { "operationId": "listModels", "tags": [ "Models" ], "summary": "The healthcare model registry", "responses": { "200": { "description": "models" } } } }, "/health/v1/models/{id}": { "get": { "operationId": "getModel", "tags": [ "Models" ], "summary": "One model with its immutable version chain and measured evaluations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "model" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/providers": { "get": { "operationId": "listProviders", "tags": [ "Providers" ], "summary": "Providers visible to this organization", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "providers" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/providers/register": { "post": { "operationId": "registerProvider", "tags": [ "Providers" ], "summary": "Register a provider (lands PENDING; receives no work until an operator approves it)", "responses": { "201": { "description": "provider and one-time secret" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/providers/{id}/heartbeat": { "post": { "operationId": "providerHeartbeat", "tags": [ "Providers" ], "summary": "Worker liveness", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "liveness" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/organization": { "get": { "operationId": "getOrganization", "tags": [ "Organization" ], "summary": "This organization, its healthcare status and your key's scopes", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "organization" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/keys": { "get": { "operationId": "listKeys", "tags": [ "Organization" ], "summary": "API keys (hashes only — raw keys are never recoverable)", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "keys" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } }, "post": { "operationId": "createKey", "tags": [ "Organization" ], "summary": "Mint a scoped API key", "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "key, shown once" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/keys/{id}/rotate": { "post": { "operationId": "rotateKey", "tags": [ "Organization" ], "summary": "Rotate a key (new one minted before the old is revoked)", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "new key" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/keys/{id}": { "delete": { "operationId": "revokeKey", "tags": [ "Organization" ], "summary": "Revoke a key immediately", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "revoked" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/usage": { "get": { "operationId": "getUsage", "tags": [ "Billing" ], "summary": "Metered usage for a period", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "usage" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/billing/invoice": { "get": { "operationId": "getInvoice", "tags": [ "Billing" ], "summary": "Draft invoice for a period", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "draft invoice" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/billing/pricebook": { "get": { "operationId": "getPricebook", "tags": [ "Billing" ], "summary": "This deployment's configured prices", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "pricebook" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/audit": { "get": { "operationId": "getAudit", "tags": [ "Audit" ], "summary": "Security-relevant events (no PHI, by allowlist)", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "audit events" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/audit/verify": { "get": { "operationId": "verifyAudit", "tags": [ "Audit" ], "summary": "Walk the audit hash chain", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "chain verdict" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/data/delete": { "post": { "operationId": "deleteData", "tags": [ "Privacy" ], "summary": "Hard-delete stored content for a job or an organization", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "deletion record" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/data/deletions": { "get": { "operationId": "listDeletions", "tags": [ "Privacy" ], "summary": "Deletion history", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "deletions" }, "400": { "description": "400 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "401": { "description": "401 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "403": { "description": "403 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "404": { "description": "404 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "405": { "description": "405 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "409": { "description": "409 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "413": { "description": "413 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "429": { "description": "429 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "502": { "description": "502 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "503": { "description": "503 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } }, "504": { "description": "504 — see the error code", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "detail" ], "properties": { "error": { "type": "string", "enum": [ "INVALID_REQUEST", "INVALID_FHIR", "PAYLOAD_TOO_LARGE", "POLICY_VIOLATION", "MODEL_NOT_ALLOWED", "AUTHORIZATION_FAILED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "RATE_LIMITED", "QUOTA_EXCEEDED", "RECEIPT_INVALID", "SECURE_CAPACITY_UNAVAILABLE", "RESIDENCY_CAPACITY_UNAVAILABLE", "PROVIDER_NOT_APPROVED", "MODEL_UNAVAILABLE", "SERVICE_UNAVAILABLE", "EXECUTION_TIMEOUT", "EXECUTION_FAILED" ], "description": "stable machine-readable error code" }, "detail": { "type": "string", "description": "human-readable explanation written by Animica; never echoes request content" }, "request_id": { "type": "string" } } } } } } } } }, "/health/v1/terminology/systems": { "get": { "operationId": "listTerminologySystems", "tags": [ "Terminology" ], "summary": "Which vocabularies are loaded here, and which are not", "responses": { "200": { "description": "systems" } } } }, "/health/v1/evaluations/suites": { "get": { "operationId": "listSuites", "tags": [ "Models" ], "summary": "Available evaluation suites", "responses": { "200": { "description": "suites" } } } } } }