Run (or re-run) developability analysis for a design
curl --request POST \
--url https://api.example.com/v1/adc-designs/{design_id}/analysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"structure_job_id": "33aabbcc-4455-6677-8899-0011aabbccdd"
}
'import requests
url = "https://api.example.com/v1/adc-designs/{design_id}/analysis"
payload = { "structure_job_id": "33aabbcc-4455-6677-8899-0011aabbccdd" }
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({structure_job_id: '33aabbcc-4455-6677-8899-0011aabbccdd'})
};
fetch('https://api.example.com/v1/adc-designs/{design_id}/analysis', 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/adc-designs/{design_id}/analysis",
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([
'structure_job_id' => '33aabbcc-4455-6677-8899-0011aabbccdd'
]),
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/adc-designs/{design_id}/analysis"
payload := strings.NewReader("{\n \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\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/adc-designs/{design_id}/analysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/adc-designs/{design_id}/analysis")
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 \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\n}"
response = http.request(request)
puts response.read_body{
"linker": {
"linker_name": "<string>",
"linker_type": "<string>",
"cleavable": true,
"release_trigger": "<string>",
"plasma_stability": "<string>",
"bystander_effect": true,
"risk": "<string>",
"warnings": [
"<string>"
],
"notes": "<string>"
},
"payload": {
"payload_name": "<string>",
"payload_class": "<string>",
"mechanism": "<string>",
"clogp": 123,
"aggregation_risk": "<string>",
"max_dar_tolerated": 123,
"notes": "<string>"
},
"conjugation": {
"method": "<string>",
"dar_control": "<string>",
"expected_dar": "<string>",
"site_heterogeneity": "<string>",
"stability": "<string>",
"notes": "<string>"
},
"overall_risk": "<string>",
"dar_mismatch_warning": "<string>",
"conjugation_sites": [
{
"residue": "<string>",
"chain": "<string>",
"position": 123,
"residue_type": "<string>",
"relative_sasa": 123,
"accessible": true,
"note": "<string>"
}
],
"summary": "<string>"
}{
"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"
}adc-designs
Run (or re-run) developability analysis for a design
Compute rule-based ADC developability analysis and persist it.
Pass structure_job_id to include SASA-based conjugation-site
accessibility analysis; omit it to run the sequence-only rules. The
result is persisted to adc_designs.analysis and also returned in
the response body — subsequent GET /v1/adc-designs/{id} calls
surface the cached analysis without re-running.
A foreign-org structure_job_id returns 404 before any
storage access — the service-role client can’t be used to exfiltrate
another tenant’s PDB bytes.
Plan gate. None today — analysis is cheap, rule-based, and free. 402 is declared on the spec because the /v1 OpenAPI regression pins it on every POST, and future plan gates will surface as 402.
Idempotency. The idempotency middleware caches POST replays by
Idempotency-Key header. Since the rule-based analysis is
deterministic given the design row + PDB, replaying under the same
key returns the cached response — consistent with the GET-side
analysis column, which is written by this endpoint.
Cost: write — burns rate + quota. Does not debit credits.
POST
/
v1
/
adc-designs
/
{design_id}
/
analysis
Run (or re-run) developability analysis for a design
curl --request POST \
--url https://api.example.com/v1/adc-designs/{design_id}/analysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"structure_job_id": "33aabbcc-4455-6677-8899-0011aabbccdd"
}
'import requests
url = "https://api.example.com/v1/adc-designs/{design_id}/analysis"
payload = { "structure_job_id": "33aabbcc-4455-6677-8899-0011aabbccdd" }
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({structure_job_id: '33aabbcc-4455-6677-8899-0011aabbccdd'})
};
fetch('https://api.example.com/v1/adc-designs/{design_id}/analysis', 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/adc-designs/{design_id}/analysis",
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([
'structure_job_id' => '33aabbcc-4455-6677-8899-0011aabbccdd'
]),
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/adc-designs/{design_id}/analysis"
payload := strings.NewReader("{\n \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\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/adc-designs/{design_id}/analysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/adc-designs/{design_id}/analysis")
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 \"structure_job_id\": \"33aabbcc-4455-6677-8899-0011aabbccdd\"\n}"
response = http.request(request)
puts response.read_body{
"linker": {
"linker_name": "<string>",
"linker_type": "<string>",
"cleavable": true,
"release_trigger": "<string>",
"plasma_stability": "<string>",
"bystander_effect": true,
"risk": "<string>",
"warnings": [
"<string>"
],
"notes": "<string>"
},
"payload": {
"payload_name": "<string>",
"payload_class": "<string>",
"mechanism": "<string>",
"clogp": 123,
"aggregation_risk": "<string>",
"max_dar_tolerated": 123,
"notes": "<string>"
},
"conjugation": {
"method": "<string>",
"dar_control": "<string>",
"expected_dar": "<string>",
"site_heterogeneity": "<string>",
"stability": "<string>",
"notes": "<string>"
},
"overall_risk": "<string>",
"dar_mismatch_warning": "<string>",
"conjugation_sites": [
{
"residue": "<string>",
"chain": "<string>",
"position": 123,
"residue_type": "<string>",
"relative_sasa": 123,
"accessible": true,
"note": "<string>"
}
],
"summary": "<string>"
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Body for POST /v1/adc-designs/{id}/analysis.
Optional structure-prediction job whose PDB should be loaded for conjugation-site SASA analysis. Must belong to the caller's org; cross-org ids return 404. Omit to run sequence-only rule-based analysis.
Example:
"33aabbcc-4455-6677-8899-0011aabbccdd"
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes