Skip to main content
POST
/
v1
/
antigens
Register a new antigen target
curl --request POST \
  --url https://api.example.com/v1/antigens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Extracellular domain, UniProt P04626 residues 23-652",
  "name": "HER2 ECD",
  "project_id": "7b4a3c0f-2e6d-4c7a-9e8f-1d3b5a2c4e6f",
  "sequence": "TQVCTGTDMKLRLPASPETHLDMLRHLYQGCQVV..."
}
'
{
  "created_at": "2026-04-23T14:15:00+00:00",
  "description": "Extracellular domain, UniProt P04626 residues 23-652",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "HER2 ECD",
  "object": "antigen",
  "project_id": "7b4a3c0f-2e6d-4c7a-9e8f-1d3b5a2c4e6f",
  "sequence": "TQVCTGTDMKLRLPASPETHLDMLRHLYQGCQVV..."
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Body for POST /v1/antigens.

project_id
string
required

Project the antigen belongs to. Must be owned by the caller's org.

Example:

"7b4a3c0f-2e6d-4c7a-9e8f-1d3b5a2c4e6f"

name
string
required

Short human label (e.g. HER2 ECD). Shown in dashboards and logs.

Required string length: 1 - 120
Example:

"HER2 ECD"

sequence
string
required

Target protein sequence, 10–800 canonical amino acids. Submit only the domain you want to dock (e.g. the ECD), not the full-length protein — Boltz-2 runtime scales superlinearly with sequence length.

Example:

"EVQLVESGGGLVQPGGSLRLSCAASGFN..."

description
string | null

Optional freeform note shown alongside the antigen.

Response

Successful Response

An antigen target registered under a project.

id
string
required

Opaque antigen identifier (UUID).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

project_id
string
required

Project this antigen belongs to.

Example:

"7b4a3c0f-2e6d-4c7a-9e8f-1d3b5a2c4e6f"

name
string
required

Echo of the caller's name.

sequence
string
required

Canonical-AA sequence supplied at create time.

created_at
string
required

ISO-8601 timestamp (UTC) when the antigen was registered.

object
string
default:antigen

Polymorphic discriminator. Always antigen.

Allowed value: "antigen"
description
string | null

Echo of the caller's description, if any.