Link an antigen to a candidate

curl --request POST \
  --url https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}', 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/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

therapeutic-candidates

Link an antigen to a candidate

Attach an antigen target to the candidate.

Both the candidate and the antigen must walk back to the caller’s org; either-side cross-org hits return 404. Links are separate from the antigen_id supplied at complex-prediction submit time — this endpoint maintains the cataloguing relationship; complex predictions are free to target any antigen in the caller’s org regardless of the candidate’s linked set.

Cost: write — burns rate + quota. Does not debit credits.

POST

therapeutic-candidates

{candidate_id}

antigens

{antigen_id}

Link an antigen to a candidate

curl --request POST \
  --url https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}', 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/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/therapeutic-candidates/{candidate_id}/antigens/{antigen_id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

Path Parameters

candidate_id

string<uuid>

required

antigen_id

string<uuid>

required

Response

Successful Response

Detach a source antibody from a candidate Detach an antigen from a candidate

Getting started

Guides

API Reference

Link an antigen to a candidate

Authorizations

Path Parameters

Response