Get experiment

curl --request GET \
  --url https://foundry-api-public.adaptyvbio.com/experiments/{exp_id} \
  --header 'Authorization: Bearer <token>'

{
  "code": "<string>",
  "created_at": "<string>",
  "experiment_spec": {
    "experiment_type": "affinity",
    "antigen_concentrations": [
      123
    ],
    "method": "bli",
    "n_replicates": 1,
    "parameters": "<unknown>",
    "sequences": {},
    "target_id": "<string>"
  },
  "experiment_url": "<string>",
  "id": "<string>",
  "name": "<string>",
  "results_status": "none",
  "status": "draft",
  "stripe_invoice_id": "<string>",
  "stripe_quote_id": "<string>"
}

experiments

Get experiment

Returns full metadata for an experiment: workflow status, target and sequence details, assay parameters, and billing references.

Poll this endpoint to track progress. When stripe_quote_id appears, fetch quote details via /experiments/{id}/quote. After confirmation, stripe_invoice_id links to the invoice. The results_status field signals data availability: None (pending), Partial (preliminary), or All (complete). Query /results filtered by experiment to retrieve data once results are available.

GET

experiments

{exp_id}

Get experiment

curl --request GET \
  --url https://foundry-api-public.adaptyvbio.com/experiments/{exp_id} \
  --header 'Authorization: Bearer <token>'

{
  "code": "<string>",
  "created_at": "<string>",
  "experiment_spec": {
    "experiment_type": "affinity",
    "antigen_concentrations": [
      123
    ],
    "method": "bli",
    "n_replicates": 1,
    "parameters": "<unknown>",
    "sequences": {},
    "target_id": "<string>"
  },
  "experiment_url": "<string>",
  "id": "<string>",
  "name": "<string>",
  "results_status": "none",
  "status": "draft",
  "stripe_invoice_id": "<string>",
  "stripe_quote_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

exp_id

string

required

Unique experiment request identifier

Response

Successfully retrieved experiment details

Detailed information about a specific experiment.

Contains all data needed to understand experiment configuration and track progress.

code

string

required

Unique experiment code (e.g., "EXP-2024-001") or request ID if not fulfilled

created_at

string

required

ISO 8601 timestamp of experiment creation

experiment_spec

object

required

Unified experiment specification (type, target, sequences, params)

Show child attributes

experiment_spec.experiment_type

enum<string>

required

Assay type: affinity, screening, or thermostability

Available options:

affinity,

screening,

thermostability

experiment_spec.antigen_concentrations

number<double>[] | null

Antigen concentrations to test (in Molar)

experiment_spec.method

enum<string>

Measurement method (BLI or SPR). Defaults to BLI.

Available options:

bli,

spr

experiment_spec.n_replicates

integer<int32> | null

Number of technical replicates (minimum 1, recommended 3+)

Required range: x >= 0

experiment_spec.parameters

any

Additional experiment-specific parameters

experiment_spec.sequences

object

Sequences keyed by a human readable name. Accepts either simple FASTA strings or rich objects with control flags and metadata.

Show child attributes

experiment_spec.sequences.{key}

Flexible sequence input for experiment creation.

Accepts a simple FASTA string or a rich object with control flag and metadata.

experiment_spec.target_id

string | null

UUID of the target antigen from the catalog

experiment_url

string

required

URL to view the experiment in the Foundry portal

string

required

Unique identifier for the experiment

name

string

required

Human-readable name for the experiment

results_status

enum<string>

required

Indicates whether results are available for this experiment

Available options:

none,

partial,

all

status

enum<string>

required

Current lifecycle status of the experiment

Available options:

draft,

waiting_for_confirmation,

canceled,

waiting_for_materials,

in_production,

quote_sent,

in_queue,

data_analysis,

in_review,

done

stripe_invoice_id

string | null

Stripe invoice ID if invoiced

stripe_quote_id

string | null

Stripe quote ID if quote was generated

Create experiment Confirm experiment

Getting Started

API Endpoints

Get experiment

Authorizations

Path Parameters

Response