Skip to main content
GET
/
api
/
v1
/
experiments
/
{exp_id}
Get experiment
curl --request GET \
  --url https://foundry-api-public.adaptyvbio.com/api/v1/experiments/{exp_id} \
  --header 'Authorization: Bearer <token>'
{
  "code": "<string>",
  "created_at": "<string>",
  "experiment_spec": {
    "experiment_type": "affinity",
    "antigen_concentrations": [
      1000,
      316.2,
      100,
      31.6,
      0
    ],
    "method": "bli",
    "n_replicates": 3,
    "parameters": "<unknown>",
    "sequences": {},
    "target_id": "c383cc1d-fe22-5dbf-953c-378bc073019d"
  },
  "experiment_url": "<string>",
  "id": "<string>",
  "results_status": "none",
  "status": "draft",
  "costs": "<unknown>",
  "name": "<string>",
  "stripe_invoice_url": "<string>",
  "stripe_quote_url": "<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)

​
experiment_url
string
required

URL to view the experiment in the Foundry portal

​
id
string
required

Unique identifier 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
​
costs
object

Dynamic cost information for this experiment.

The value depends on experiment lifecycle and creation date:

  • null: Pricing unavailable (experiments created before 2026-01-20)
  • {type: "estimate", ...}: Computed estimate (no Stripe quote yet)
  • {type: "quoted", ...}: Stripe quote generated
  • {type: "invoiced", ...}: Stripe invoice created

Resolution: invoice_id present → Invoiced, else quote_id present → Quoted, else compute Estimate from experiment spec.

​
name
string | null

Human-readable name for the experiment (nullable in database)

​
stripe_invoice_url
string | null

URL to view/pay invoice

​
stripe_quote_url
string | null

URL to view quote in payment provider dashboard