Skip to main content
POST
/
api
/
v1
/
targets
/
request-custom
Submit custom target request
curl --request POST \
  --url https://devs.adaptyvbio.com/api/v1/targets/request-custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Custom Antigen",
  "product_id": "CUSTOM-001",
  "molecular_weight": 15.5,
  "note": "Expressed in HEK293 cells",
  "pdb_file": "<string>",
  "pdb_id": "1HHO",
  "product_url": "https://www.acrobiosystems.com/product/PD1",
  "sequence": "MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH",
  "vendor": "ACRO Biosystems"
}
'
import requests

url = "https://devs.adaptyvbio.com/api/v1/targets/request-custom"

payload = {
"name": "My Custom Antigen",
"product_id": "CUSTOM-001",
"molecular_weight": 15.5,
"note": "Expressed in HEK293 cells",
"pdb_file": "<string>",
"pdb_id": "1HHO",
"product_url": "https://www.acrobiosystems.com/product/PD1",
"sequence": "MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH",
"vendor": "ACRO Biosystems"
}
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({
name: 'My Custom Antigen',
product_id: 'CUSTOM-001',
molecular_weight: 15.5,
note: 'Expressed in HEK293 cells',
pdb_file: '<string>',
pdb_id: '1HHO',
product_url: 'https://www.acrobiosystems.com/product/PD1',
sequence: 'MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH',
vendor: 'ACRO Biosystems'
})
};

fetch('https://devs.adaptyvbio.com/api/v1/targets/request-custom', 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://devs.adaptyvbio.com/api/v1/targets/request-custom",
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([
'name' => 'My Custom Antigen',
'product_id' => 'CUSTOM-001',
'molecular_weight' => 15.5,
'note' => 'Expressed in HEK293 cells',
'pdb_file' => '<string>',
'pdb_id' => '1HHO',
'product_url' => 'https://www.acrobiosystems.com/product/PD1',
'sequence' => 'MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH',
'vendor' => 'ACRO Biosystems'
]),
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://devs.adaptyvbio.com/api/v1/targets/request-custom"

payload := strings.NewReader("{\n \"name\": \"My Custom Antigen\",\n \"product_id\": \"CUSTOM-001\",\n \"molecular_weight\": 15.5,\n \"note\": \"Expressed in HEK293 cells\",\n \"pdb_file\": \"<string>\",\n \"pdb_id\": \"1HHO\",\n \"product_url\": \"https://www.acrobiosystems.com/product/PD1\",\n \"sequence\": \"MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH\",\n \"vendor\": \"ACRO Biosystems\"\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://devs.adaptyvbio.com/api/v1/targets/request-custom")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Custom Antigen\",\n \"product_id\": \"CUSTOM-001\",\n \"molecular_weight\": 15.5,\n \"note\": \"Expressed in HEK293 cells\",\n \"pdb_file\": \"<string>\",\n \"pdb_id\": \"1HHO\",\n \"product_url\": \"https://www.acrobiosystems.com/product/PD1\",\n \"sequence\": \"MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH\",\n \"vendor\": \"ACRO Biosystems\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://devs.adaptyvbio.com/api/v1/targets/request-custom")

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 \"name\": \"My Custom Antigen\",\n \"product_id\": \"CUSTOM-001\",\n \"molecular_weight\": 15.5,\n \"note\": \"Expressed in HEK293 cells\",\n \"pdb_file\": \"<string>\",\n \"pdb_id\": \"1HHO\",\n \"product_url\": \"https://www.acrobiosystems.com/product/PD1\",\n \"sequence\": \"MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH\",\n \"vendor\": \"ACRO Biosystems\"\n}"

response = http.request(request)
puts response.read_body
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
"error": "experiment not found",
"request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}
{
"error": "experiment not found",
"request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}
{
"error": "experiment not found",
"request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}
{
"error": "experiment not found",
"request_id": "req_019462a4-b1c2-7def-8901-23456789abcd"
}

Authorizations

Authorization
string
header
required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Body

application/json

Request payload for submitting a custom target with sequence or PDB data.

Users can submit their own targets for review. At least one of sequence or pdb_id must be provided. Approved targets are added to the catalog and can be used in experiments.

name
string
required

Display name for the target

Example:

"My Custom Antigen"

product_id
string
required

User-provided identifier, must be unique within your organization

Example:

"CUSTOM-001"

molecular_weight
number<double> | null

Molecular weight in kilodaltons (kDa)

Example:

15.5

note
string | null

Additional notes or context about the target

Example:

"Expressed in HEK293 cells"

pdb_file
string | null

Base64-encoded PDB file content for custom structures not in the PDB

pdb_id
string | null

PDB database identifier (e.g., "1ABC", "6LU7")

Example:

"1HHO"

product_url
string | null

URL to vendor product page or documentation

Example:

"https://www.acrobiosystems.com/product/PD1"

sequence
string | null

Amino acid sequence using standard single-letter codes (A-Z excluding B, J, X, Z). Supports standard 20 amino acids plus selenocysteine (U) and pyrrolysine (O).

Example:

"MVLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSH"

vendor
string | null

Source vendor name if applicable

Example:

"ACRO Biosystems"

Response

Request submitted successfully

Response after submitting a custom target request.

created_at
string<date-time>
required

ISO 8601 timestamp when the request was created

id
string<uuid>
required

Unique identifier assigned to the request

status
enum<string>
required

Current status (always "pending_review" for new submissions)

Available options:
pending_review,
approved,
rejected