Skip to main content
POST
/
experiments
Create experiment
curl --request POST \
  --url https://foundry-api-public.adaptyvbio.com/experiments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_spec": {
    "experiment_type": "affinity",
    "antigen_concentrations": [
      123
    ],
    "method": "bli",
    "n_replicates": 1,
    "parameters": "<unknown>",
    "sequences": {},
    "target_id": "<string>"
  },
  "name": "<string>",
  "id": "<string>",
  "webhook_url": "<string>"
}
'
{
  "experiment_id": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Request payload for creating or updating an experiment.

Supports upsert semantics: omit id to create a new experiment, or provide an existing experiment's UUID to update it. Created experiments start in Draft status. Updates replace sequences entirely rather than merging.

experiment_spec
object
required

Structured experiment definition (type, target, sequences, parameters)

name
string
required

Human-readable name for the experiment

id
string | null

Experiment UUID for updates. Omit to create a new experiment.

webhook_url
string | null

URL to which experiment status updates will be POSTed

Response

Experiment updated successfully (when id provided)

Response confirming experiment creation.

experiment_id
string
required

Unique identifier assigned to the new experiment