Submit a humanization job

curl --request POST \
  --url https://api.example.com/v1/humanizations \
  --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/humanizations"

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/humanizations', 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/humanizations",
  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/humanizations"

	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/humanizations")
  .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/humanizations")

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:15:28+00:00",
  "created_at": "2026-04-22T14:15:00+00:00",
  "credit_cost": 1,
  "id": "dddd1111-eeee-2222-ffff-333344445555",
  "inputs": {
    "variant_id": "11112222-3333-4444-5555-666677778888"
  },
  "object": "humanization",
  "results": [
    {
      "humanized_vh": "EVQLVESGGGLVQPGGSLRLSCAAS...",
      "humanized_vl": "DIQMTQSPSSLSASVGDRVTITCRASQ...",
      "liabilities": {
        "glycosylation": [],
        "oxidation": [
          "H100"
        ]
      },
      "mutations": {
        "vh": 12,
        "vl": 8
      },
      "oasis_score": {
        "mean": 0.91,
        "median": 0.93
      },
      "strategy": "cdr_grafting"
    }
  ],
  "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"
}

humanizations

Submit a humanization job

Submit a humanization pipeline run against a variant. Returns 202 Accepted with status=pending; poll GET /v1/humanizations/{id} until status=completed or failed.

Idempotency. Send a unique Idempotency-Key per submission — replays return the cached 202 without enqueuing a second job or re-spending credits. A replay with a different body returns 409 idempotency_mismatch.

Credits. Humanization costs 1 credit per submission, debited against the caller’s organization balance. Insufficient credits at submit time surface as 402 insufficient_credits with credit_cost / credit_balance in the problem+json body.

Prefer: wait. Pass Prefer: wait=<seconds> (max 120) to run the pipeline synchronously and receive a 200 response with status=completed (or status=failed) instead of polling. The server adds a Preference-Applied: wait=<N> header on success. Omitting the header or sending Prefer: respond-async preserves the standard 202 async flow.

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

POST

humanizations

Submit a humanization job

curl --request POST \
  --url https://api.example.com/v1/humanizations \
  --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/humanizations"

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/humanizations', 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/humanizations",
  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/humanizations"

	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/humanizations")
  .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/humanizations")

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:15:28+00:00",
  "created_at": "2026-04-22T14:15:00+00:00",
  "credit_cost": 1,
  "id": "dddd1111-eeee-2222-ffff-333344445555",
  "inputs": {
    "variant_id": "11112222-3333-4444-5555-666677778888"
  },
  "object": "humanization",
  "results": [
    {
      "humanized_vh": "EVQLVESGGGLVQPGGSLRLSCAAS...",
      "humanized_vl": "DIQMTQSPSSLSASVGDRVTITCRASQ...",
      "liabilities": {
        "glycosylation": [],
        "oxidation": [
          "H100"
        ]
      },
      "mutations": {
        "vh": 12,
        "vl": 8
      },
      "oasis_score": {
        "mean": 0.91,
        "median": 0.93
      },
      "strategy": "cdr_grafting"
    }
  ],
  "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/humanizations.

variant_id

string

required

UUID of the variant to humanize. Must belong to the caller's org. Strategy selection is not yet settable via the API — the pipeline runs all configured strategies on every submit.

Example:

"11112222-3333-4444-5555-666677778888"

Response

Successful Response

Humanization job envelope — pipeline status + typed results.

Field layout matches the shared spec in docs/strategy/api-plan.md so the next 5 resource-per-job-type endpoints can ship identical envelopes and the Python SDK can define one Job base class.

string

required

Opaque humanization identifier (UUID).

Example:

"dddd1111-eeee-2222-ffff-333344445555"

status

enum<string>

required

Lifecycle state. pending → running → completed | failed. canceled is terminal and only reachable via POST /v1/humanizations/{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:

1

inputs

HumanizationInputs · object

required

Echo of the caller's submit body — useful for clients that don't cache.

Show child attributes

object

string

default:humanization

Polymorphic discriminator. Always humanization on this endpoint.

Allowed value: "humanization"

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

failed_at

string | null

ISO-8601 timestamp when the job failed. null unless status=failed. Synthesized from the underlying job's terminal timestamp — the DB does not carry a separate failed_at column.

canceled_at

string | null

ISO-8601 timestamp when the job was canceled via POST /v1/humanizations/{id}/cancel. null unless status=canceled.

error

HumanizationError · object | null

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

Show child attributes

results

HumanizationResultEntry · object[] | null

Per-strategy humanization outputs. null until status=completed; empty list is valid if the pipeline produced no viable strategies.

Show child attributes

Getting started

Guides

API Reference

Submit a humanization job

Authorizations

Body

Response