Skip to main content
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>",
  "format": "mab",
  "initial_chains": [
    {
      "chain_id": "<string>",
      "role": "heavy",
      "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"
  ]
}
'
{
  "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"
}

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
​
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.

​
id
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