Skip to main content
GET
Get experiment

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

Response

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<date-time>
required

ISO 8601 timestamp of experiment creation

experiment_spec
object
required

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

experiment_url
string
required

URL to view the experiment in the Foundry portal

id
string<uuid>
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_id
string | null

Stripe quote identifier (e.g. qt_1Abc2Def), when a quote exists.

Exposed so integrations can call the /quotes/{quote_id} family of endpoints without parsing the ID out of stripe_quote_url. Tracks the upstream Stripe quote; changes if the quote is regenerated (rare).

stripe_quote_url
string | null

URL to view quote in payment provider dashboard