> ## Documentation Index > Fetch the complete documentation index at: https://docs.kallima.bio/llms.txt > Use this file to discover all available pages before exploring further. # List immunogenicity analyses for a variant > List immunogenicity analyses for one variant, newest-first. ``?variant_id=`` is required. The listed envelopes carry status + credit_cost + inputs but **not** the typed ``results`` object; fetch the single resource with ``GET /v1/immunogenicity-analyses/{id}`` for full output. Cost: **read** — rate bucket only. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/immunogenicity-analyses openapi: 3.1.0 info: title: Kallima API description: >- Antibody design API — humanization, structure, stability, immunogenicity, complex prediction, and codon optimization. version: 0.1.0 servers: [] security: [] tags: - name: identity description: >- Caller identity and credit balance — use ``GET /v1/me`` to inspect the resolved org, plan, and compute budget before submitting jobs. - name: projects description: >- Projects — top-level containers for source antibodies and therapeutic candidates. - name: source-antibodies description: Source (parental) antibody sequences registered under a project. - name: variants description: >- Variants descended from a therapeutic candidate — the unit of work for pipelines. - name: jobs description: >- Long-running pipeline jobs: humanization, structure, stability, immunogenicity. Submit and poll. Deprecated in favor of resource-per-job-type endpoints (``humanizations`` and the other Phase 3 resources); scheduled for removal in ``/v2``. - name: humanizations description: >- Humanization pipeline runs — typed submit body and typed per-strategy results. First of the Phase 3 resource-per-job-type endpoints; the generic ``/v1/jobs`` shape is deprecated in favor of this. - name: structure-predictions description: >- ImmuneBuilder structure predictions — typed submit body and typed PDB / pLDDT / CDR results. Phase 3 resource-per-job-type endpoint. - name: stability-analyses description: >- Stability analyses — typed submit body and typed thermostability / aggregation / developability scorecard. Phase 3 resource-per-job-type endpoint. - name: immunogenicity-analyses description: >- Immunogenicity analyses — typed submit body and typed MHC-I / MHC-II / B-cell epitope + risk-score results. Phase 3 resource-per-job-type endpoint. - name: uploads description: >- Presigned Supabase Storage slots for caller-supplied files (e.g. antigen PDBs for complex prediction). The API never proxies bytes — clients PUT directly to the returned URL. - name: antigens description: >- Target protein sequences scoped to a project — the docking partner in a complex prediction. Register once, reference by ``antigen_id`` at submit time. - name: complex-predictions description: >- Boltz-2 antibody-antigen complex predictions — typed submit body and typed docked-PDB / iptm / interface-residues results. Phase 3 resource-per-job-type endpoint. Complex runs are long-running (~20–40 min on GPU); always poll, never hold the connection. - name: therapeutic-candidates description: >- Therapeutic candidates — the top-of-lineage object under a project. Creating one auto-creates a baseline variant (``v1``) and its chain rows atomically; pipelines submit against the variant. Junction endpoints manage many-to-many links to source antibodies and antigens. - name: adc-designs description: >- ADC (antibody-drug conjugate) designs — catalog records attaching a linker + payload + conjugation method to a therapeutic candidate. Run the rule-based developability analysis via ``POST /v1/adc-designs/{id}/analysis``; pass ``structure_job_id`` to include SASA-based conjugation-site accessibility. - name: codon-exports description: >- Codon optimization exports — submit a batch of jobs (one per variant), poll until ``variable_cds`` is populated, then download the assembled CDS as FASTA, CSV, or GenBank+ZIP. Requires the Structure plan or above. - name: webhooks description: >- Webhook endpoint registration — register HTTPS URLs to receive signed event deliveries when jobs complete or fail. Signing uses HMAC-SHA256; see ``POST /v1/webhooks`` for verification details. - name: webhook-deliveries description: >- Webhook delivery log — inspect past delivery attempts and manually retry failed ones via ``POST /v1/webhook_deliveries/{id}/retry``. paths: /v1/immunogenicity-analyses: get: tags: - immunogenicity-analyses summary: List immunogenicity analyses for a variant description: |- List immunogenicity analyses for one variant, newest-first. ``?variant_id=`` is required. The listed envelopes carry status + credit_cost + inputs but **not** the typed ``results`` object; fetch the single resource with ``GET /v1/immunogenicity-analyses/{id}`` for full output. Cost: **read** — rate bucket only. operationId: list_immunogenicity_analyses_v1_immunogenicity_analyses_get parameters: - name: variant_id in: query required: true schema: type: string format: uuid title: Variant Id - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 50 title: Limit - name: after in: query required: false schema: anyOf: - type: string - type: 'null' title: After responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_ImmunogenicityAnalysis_' '400': description: Malformed request body or parameter. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: Missing or invalid API token. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource does not exist in the caller's organization. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '422': description: Request failed validation. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '429': description: >- Rate limit or monthly write quota exceeded. `Retry-After` holds the number of seconds until the next admitted request. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' headers: Retry-After: description: Seconds until the caller may retry. Present on 429 responses. schema: type: integer minimum: 1 X-RateLimit-Limit: description: Per-minute rate ceiling for this API token's plan. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the current rate window. schema: type: integer X-RateLimit-Reset: description: HTTP-date when the rate window resets. schema: type: string format: http-date X-Quota-Limit: description: Monthly write ceiling for this API token's plan. schema: type: integer X-Quota-Remaining: description: Writes remaining in the current monthly window. schema: type: integer X-Quota-Reset: description: >- HTTP-date when the monthly write quota resets (always the 1st of next month UTC). schema: type: string format: http-date security: - HTTPBearer: [] components: schemas: PaginatedResponse_ImmunogenicityAnalysis_: properties: data: items: $ref: '#/components/schemas/ImmunogenicityAnalysis' type: array title: Data has_more: type: boolean title: Has More next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor type: object required: - data - has_more title: PaginatedResponse[ImmunogenicityAnalysis] ProblemDetails: additionalProperties: true description: RFC 9457 problem+json body returned by every non-2xx response. example: code: insufficient_credits credit_balance: 0 credit_cost: 1 detail: Humanization costs 1 credit; balance is 0. instance: /v1/jobs request_id: req_01JBX6Y6ZK6N8Q7YJ0F5VX2C3D status: 402 title: Insufficient credits type: https://docs.kallima.bio/errors/insufficient_credits properties: type: description: >- Stable URI identifying the error class. Dereferenceable at docs.kallima.bio/errors/{code}. examples: - https://docs.kallima.bio/errors/insufficient_credits title: Type type: string title: description: Short human-readable summary of the error class. examples: - Insufficient credits title: Title type: string status: description: HTTP status code. Matches the response status line. examples: - 402 title: Status type: integer detail: description: Human-readable explanation with values substituted. examples: - Humanization costs 1 credit; balance is 0. title: Detail type: string instance: description: The specific request URI that failed. examples: - /v1/jobs title: Instance type: string code: description: >- Machine-readable short code. SDKs switch on this, not on `title`. See app.errors.ErrorCode for the full taxonomy. examples: - insufficient_credits title: Code type: string request_id: anyOf: - type: string - type: 'null' default: null description: ULID stamped on every request. Include when contacting support. examples: - req_01JBX6Y6ZK6N8Q7YJ0F5VX2C3D title: Request Id required: - type - title - status - detail - instance - code title: ProblemDetails type: object ImmunogenicityAnalysis: properties: id: type: string title: Id description: Opaque immunogenicity-analysis identifier (UUID). examples: - cccc3333-dddd-4444-eeee-555566667777 object: type: string const: immunogenicity_analysis title: Object description: Polymorphic discriminator. Always ``immunogenicity_analysis``. default: immunogenicity_analysis status: type: string enum: - pending - running - completed - failed - canceled title: Status description: >- Lifecycle state. ``pending`` → ``running`` → ``completed`` | ``failed``. ``canceled`` is terminal and only reachable via ``POST /v1/immunogenicity-analyses/{id}/cancel`` on a still-pending job. examples: - pending created_at: type: string title: Created At description: ISO-8601 timestamp (UTC) when the job was submitted. examples: - '2026-04-22T14:15:00+00:00' started_at: anyOf: - type: string - type: 'null' title: Started At description: ISO-8601 timestamp when execution started. ``null`` while pending. completed_at: anyOf: - type: string - type: 'null' title: Completed At description: ISO-8601 timestamp when the job completed successfully. failed_at: anyOf: - type: string - type: 'null' title: Failed At description: >- ISO-8601 timestamp when the job failed. ``null`` unless ``status=failed``. canceled_at: anyOf: - type: string - type: 'null' title: Canceled At description: >- ISO-8601 timestamp when the job was canceled. ``null`` unless ``status=canceled``. error: anyOf: - $ref: '#/components/schemas/ImmunogenicityAnalysisError' - type: 'null' description: Populated only when ``status=failed``. Same shape as problem+json. credit_cost: type: integer title: Credit Cost description: Credits debited at submission for this job type. examples: - 2 inputs: $ref: '#/components/schemas/ImmunogenicityAnalysisInputs' description: Echo of the caller's submit body. results: anyOf: - $ref: '#/components/schemas/ImmunogenicityAnalysisResult' - type: 'null' description: >- Epitopes + risk scores + de-immunization suggestions. ``null`` until ``status=completed``. type: object required: - id - status - created_at - credit_cost - inputs title: ImmunogenicityAnalysis description: Immunogenicity analysis job envelope — pipeline status + typed result. example: completed_at: '2026-04-22T14:17:05+00:00' created_at: '2026-04-22T14:15:00+00:00' credit_cost: 2 id: cccc3333-dddd-4444-eeee-555566667777 inputs: variant_id: 11112222-3333-4444-5555-666677778888 object: immunogenicity_analysis results: bcell_epitopes: [] bcell_risk: 0.11 deimmunization_suggestions: [] mhc1_epitopes: [] mhc1_risk: 0.15 mhc2_epitopes: [] mhc2_risk: 0.28 model_versions: mhcflurry: 2.1.4 risk_score: 0.22 started_at: '2026-04-22T14:15:02+00:00' status: completed ImmunogenicityAnalysisError: properties: type: type: string title: Type description: Stable URI identifying the error class. examples: - https://docs.kallima.bio/errors/job_failed title: type: string title: Title description: Short human summary. examples: - Job failed status: type: integer title: Status description: HTTP-like status code. examples: - 500 detail: type: string title: Detail description: Human-readable failure reason, from the executor. examples: - 'ValueError: VH sequence is empty' code: type: string title: Code description: Machine-readable code. SDKs switch on this. examples: - job_failed type: object required: - type - title - status - detail - code title: ImmunogenicityAnalysisError description: Problem-details-shaped error surfaced on a failed immunogenicity job. ImmunogenicityAnalysisInputs: properties: variant_id: type: string title: Variant Id description: Variant the immunogenicity analysis ran against. examples: - 11112222-3333-4444-5555-666677778888 type: object required: - variant_id title: ImmunogenicityAnalysisInputs description: What the caller submitted when creating this immunogenicity analysis. ImmunogenicityAnalysisResult: properties: mhc1_epitopes: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Mhc1 Epitopes description: Predicted MHC class I epitopes with binding affinities. mhc2_epitopes: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Mhc2 Epitopes description: Predicted MHC class II epitopes with binding affinities. bcell_epitopes: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Bcell Epitopes description: Predicted linear B-cell epitopes. deimmunization_suggestions: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Deimmunization Suggestions description: Mutations that lower predicted immunogenicity risk. risk_score: anyOf: - type: number - type: 'null' title: Risk Score description: Composite immunogenicity risk score (0–1, higher = riskier). mhc1_risk: anyOf: - type: number - type: 'null' title: Mhc1 Risk description: Class I contribution to the composite risk. mhc2_risk: anyOf: - type: number - type: 'null' title: Mhc2 Risk description: Class II contribution to the composite risk. bcell_risk: anyOf: - type: number - type: 'null' title: Bcell Risk description: B-cell contribution to the composite risk. model_versions: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Model Versions description: Versions of the underlying predictors (e.g., ``mhcflurry``). type: object title: ImmunogenicityAnalysisResult description: Immunogenicity output — predicted epitopes + risk scores. securitySchemes: HTTPBearer: type: http scheme: bearer ````