Skip to main content
POST
/
v1
/
immunogenicity-analyses
Submit an immunogenicity analysis job
curl --request POST \
  --url https://api.example.com/v1/immunogenicity-analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variant_id": "11112222-3333-4444-5555-666677778888"
}
'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Body for POST /v1/immunogenicity-analyses.

​
variant_id
string
required

UUID of the variant to analyze. Must belong to the caller's org. scFv constructs are scored as the concatenated VH+linker+VL sequence.

Example:

"11112222-3333-4444-5555-666677778888"

Response

Successful Response

Immunogenicity analysis job envelope — pipeline status + typed result.

​
id
string
required

Opaque immunogenicity-analysis identifier (UUID).

Example:

"cccc3333-dddd-4444-eeee-555566667777"

​
status
enum<string>
required

Lifecycle state. pending → running → completed | failed. canceled is terminal and only reachable via POST /v1/immunogenicity-analyses/{id}/cancel on a still-pending job.

Available options:
pending,
running,
completed,
failed,
canceled
Example:

"pending"

​
created_at
string
required

ISO-8601 timestamp (UTC) when the job was submitted.

Example:

"2026-04-22T14:15:00+00:00"

​
credit_cost
integer
required

Credits debited at submission for this job type.

Example:

2

​
inputs
ImmunogenicityAnalysisInputs · object
required

Echo of the caller's submit body.

​
object
string
default:immunogenicity_analysis

Polymorphic discriminator. Always immunogenicity_analysis.

Allowed value: "immunogenicity_analysis"
​
started_at
string | null

ISO-8601 timestamp when execution started. null while pending.

​
completed_at
string | null

ISO-8601 timestamp when the job completed successfully.

​
failed_at
string | null

ISO-8601 timestamp when the job failed. null unless status=failed.

​
canceled_at
string | null

ISO-8601 timestamp when the job was canceled. null unless status=canceled.

​
error
ImmunogenicityAnalysisError · object

Populated only when status=failed. Same shape as problem+json.

​
results
ImmunogenicityAnalysisResult · object

Epitopes + risk scores + de-immunization suggestions. null until status=completed.