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"
}
'

import requests

url = "https://api.example.com/v1/immunogenicity-analyses"

payload = { "variant_id": "11112222-3333-4444-5555-666677778888" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variant_id: '11112222-3333-4444-5555-666677778888'})
};

fetch('https://api.example.com/v1/immunogenicity-analyses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/immunogenicity-analyses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variant_id' => '11112222-3333-4444-5555-666677778888'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/immunogenicity-analyses"

	payload := strings.NewReader("{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/immunogenicity-analyses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/immunogenicity-analyses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

immunogenicity-analyses

Submit an immunogenicity analysis job

Submit an immunogenicity analysis against a variant. Returns 202 Accepted with status=pending; poll GET /v1/immunogenicity-analyses/{id} until terminal.

Plan gate. Immunogenicity analysis requires the Complete plan or above; lower plans receive 402 plan_upgrade_required.

Credits. Immunogenicity analysis costs 2 credits per submission. Insufficient credits surface as 402 insufficient_credits.

Cost: write — burns rate + quota, and debits credits.

POST

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"
}
'

import requests

url = "https://api.example.com/v1/immunogenicity-analyses"

payload = { "variant_id": "11112222-3333-4444-5555-666677778888" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variant_id: '11112222-3333-4444-5555-666677778888'})
};

fetch('https://api.example.com/v1/immunogenicity-analyses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/immunogenicity-analyses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variant_id' => '11112222-3333-4444-5555-666677778888'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/immunogenicity-analyses"

	payload := strings.NewReader("{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/immunogenicity-analyses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/immunogenicity-analyses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variant_id\": \"11112222-3333-4444-5555-666677778888\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

{
  "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"
}

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.

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.

Show child attributes

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 | null

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

Show child attributes

results

ImmunogenicityAnalysisResult · object | null

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

Show child attributes

List immunogenicity analyses for a variant Fetch an immunogenicity analysis

Getting started

Guides

API Reference

Submit an immunogenicity analysis job

Authorizations

Body

Response