Skip to main content
PATCH
/
api
/
v1
/
experiments
/
{experiment_id}
Update experiment
curl --request PATCH \
  --url https://foundry-api-public.adaptyvbio.com/api/v1/experiments/{experiment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "antigen_concentrations": [
    123
  ],
  "description": "<string>",
  "n_replicates": 1,
  "name": "<string>",
  "parameters": "<unknown>",
  "sequences": [
    {
      "aa_string": "EVQLVESGGGLVQPGGSLRLSCAAS",
      "control": true,
      "metadata": "<unknown>",
      "name": "mAb1"
    }
  ],
  "target_id": "<string>",
  "webhook_url": "<string>"
}
'
{
  "id": "<string>",
  "updated": true,
  "message": "<string>"
}

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.

Path Parameters

​
experiment_id
string<uuid>
required

Unique experiment request identifier to modify

Body

application/json

Request payload for modifying an existing experiment.

All fields are optional - only provided fields will be updated. Note: Some modifications may be restricted based on experiment status. Modifications are only allowed if the experiment request is not yet fulfilled.

Status transitions are handled separately via the /experiments/{id}/confirm endpoint, which performs the appropriate transition based on current state.

​
antigen_concentrations
number<double>[] | null

Update antigen concentrations (only if not fulfilled)

​
description
string | null

Update experiment description

​
n_replicates
integer<int32> | null

Update replicate count (only if not fulfilled)

Required range: x >= 0
​
name
string | null

Update experiment name

​
parameters
any

Update experiment parameters (restrictions may apply, only if not fulfilled)

​
sequences
object[] | null

Replace sequence list (only if not fulfilled)

​
target_id
string | null

Change the experiment's catalog target (only while the experiment is editable).

  • omitted: keep the current target
  • null: clear the target
  • a catalog product UUID (as returned by GET /targets): set the target to that product
​
webhook_url
string | null

Update the webhook URL for notifications

Response

Experiment modified successfully or no action taken (e.g., already fulfilled)

Response confirming experiment modification.

​
id
string
required

Experiment identifier that was modified

​
updated
boolean
required

Indicates if any changes were applied

​
message
string | null

Optional message, e.g., if modification is not allowed