Create Candidate

curl --request POST \
  --url https://api.example.com/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "initial_chains": [
    {
      "chain_id": "<string>",
      "variable_sequence": "<string>",
      "constant_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_antibody_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "drug_class": "naked_antibody",
  "format_metadata": {},
  "description": "<string>",
  "source_antibody_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "antigen_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.example.com/candidates"

payload = {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "initial_chains": [
        {
            "chain_id": "<string>",
            "variable_sequence": "<string>",
            "constant_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "source_antibody_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "drug_class": "naked_antibody",
    "format_metadata": {},
    "description": "<string>",
    "source_antibody_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "antigen_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
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({
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    initial_chains: [
      {
        chain_id: '<string>',
        variable_sequence: '<string>',
        constant_region_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        source_antibody_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    drug_class: 'naked_antibody',
    format_metadata: {},
    description: '<string>',
    source_antibody_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    antigen_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.example.com/candidates', 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/candidates",
  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([
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'initial_chains' => [
        [
                'chain_id' => '<string>',
                'variable_sequence' => '<string>',
                'constant_region_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'source_antibody_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'drug_class' => 'naked_antibody',
    'format_metadata' => [
        
    ],
    'description' => '<string>',
    'source_antibody_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'antigen_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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/candidates"

	payload := strings.NewReader("{\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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/candidates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/candidates")

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  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "format": "<string>",
  "drug_class": "<string>",
  "format_metadata": {},
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source_antibody_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "antigen_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "initial_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

candidates

Create Candidate

curl --request POST \
  --url https://api.example.com/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "initial_chains": [
    {
      "chain_id": "<string>",
      "variable_sequence": "<string>",
      "constant_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_antibody_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "drug_class": "naked_antibody",
  "format_metadata": {},
  "description": "<string>",
  "source_antibody_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "antigen_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.example.com/candidates"

payload = {
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "initial_chains": [
        {
            "chain_id": "<string>",
            "variable_sequence": "<string>",
            "constant_region_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "source_antibody_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "drug_class": "naked_antibody",
    "format_metadata": {},
    "description": "<string>",
    "source_antibody_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "antigen_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
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({
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    initial_chains: [
      {
        chain_id: '<string>',
        variable_sequence: '<string>',
        constant_region_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        source_antibody_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    drug_class: 'naked_antibody',
    format_metadata: {},
    description: '<string>',
    source_antibody_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    antigen_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.example.com/candidates', 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/candidates",
  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([
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'initial_chains' => [
        [
                'chain_id' => '<string>',
                'variable_sequence' => '<string>',
                'constant_region_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'source_antibody_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'drug_class' => 'naked_antibody',
    'format_metadata' => [
        
    ],
    'description' => '<string>',
    'source_antibody_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'antigen_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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/candidates"

	payload := strings.NewReader("{\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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/candidates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/candidates")

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  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"initial_chains\": [\n    {\n      \"chain_id\": \"<string>\",\n      \"variable_sequence\": \"<string>\",\n      \"constant_region_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"source_antibody_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"drug_class\": \"naked_antibody\",\n  \"format_metadata\": {},\n  \"description\": \"<string>\",\n  \"source_antibody_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"antigen_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "format": "<string>",
  "drug_class": "<string>",
  "format_metadata": {},
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source_antibody_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "antigen_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "initial_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Payload to create a new therapeutic candidate.

initial_chains is required and used to auto-create the first variant (v1). For single-arm formats (mab, nanobody, scfv, fc_fusion) a single H+L pair suffices. For bispecific / multi-arm formats, supply all required chains.

project_id

string<uuid>

required

name

string

required

Required string length: 1 - 120

format

enum<string>

required

Available options:

mab,

nanobody,

scfv,

fc_fusion,

bispecific_kih,

bispecific_crossmab,

bispecific_common_lc,

bite,

dart,

dvd_ig,

tandem_scfv,

trispecific_tandem_scfv,

trispecific_igg_scfv,

trispecific_knh_scfv

initial_chains

VariantChainSpec · object[]

required

Chain specs for the initial variant (v1) that is auto-created.

Minimum array length: 1

Show child attributes

drug_class

enum<string>

default:naked_antibody

Available options:

naked_antibody,

adc,

car,

radioconjugate,

t_cell_engager

format_metadata

Format Metadata · object

description

string | null

source_antibody_ids

string<uuid>[]

antigen_ids

string<uuid>[]

Response

Successful Response

Candidate enriched with junction-table IDs.

string<uuid>

required

project_id

string<uuid>

required

name

string

required

format

string

required

drug_class

string

required

format_metadata

Format Metadata · object

required

description

string | null

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

source_antibody_ids

string<uuid>[]

antigen_ids

string<uuid>[]

initial_variant_id

string<uuid> | null

List Candidates Get Candidate

Getting started

Guides

API Reference

Create Candidate

Authorizations

Body

Response