ADadaptyvbio
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_url appears, fetch quote details via /experiments/{id}/quote. After confirmation, stripe_invoice_url provides a direct link 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/api/v1/experiments/{experiment_id}

Request

  • Base URL
    https://devs.adaptyvbio.com
  • URL
    https://devs.adaptyvbio.com/api/v1/experiments/{experiment_id}
  • Auth
    HTTP bearer

Path parameters

experiment_idstring uuid required

Unique experiment request identifier

Response

Experiment details

codestring required

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

created_atstring date-time required

ISO 8601 timestamp of experiment creation

experiment_urlstring required

URL to view the experiment in the Foundry portal

idstring uuid required

Unique identifier for the experiment

namestring nullable

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

results_status'none' | 'partial' | 'all' required

Indicates the availability of results for an experiment.

status'draft' | 'waiting_for_confirmation' | 'canceled' | 'waiting_for_materials' | 'in_production' | 'quote_sent' | 'in_queue' | 'data_analysis' | 'in_review' | 'done' required

Current lifecycle stage of an experiment.

Status values indicate where an experiment is in the submission-to-results pipeline. Some transitions require user action (such as accepting a quote), while others occur automatically as work progresses.

stripe_invoice_urlstring nullable

URL to view/pay invoice

stripe_quote_idstring nullable

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_urlstring nullable

URL to view quote in payment provider dashboard

Example response

{
  "costs": {
    "breakdown": {
      "assay": {
        "experiment_type": "screening",
        "n_replicates": 3,
        "replicate_price_cents": 2900,
        "sequence_count": 5,
        "subtotal_cents": 103500,
        "unit_price_cents": 14900
      },
      "materials": {
        "price_per_sequence_cents": 500,
        "sequence_count": 5,
        "subtotal_cents": 2500,
        "target": {
          "name": "Human PD-L1",
          "target_catalog_id": "019a03da-b87f-7e15-8b02-cef171c9871d"
        }
      },
      "total_cents": 106000
    }
  },
  "experiment_spec": {
    "antigen_concentrations": [
      1000,
      316.2,
      100,
      31.6,
      0
    ],
    "n_replicates": 3,
    "target": {
      "name": "Human PD-L1",
      "target_catalog_id": "019a03da-b87f-7e15-8b02-cef171c9871d"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.