Skip to main content
POST
Create Experiment

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-11"

Body

application/json
account_id
string
required

Owning account tag or internal. Required; ownership cannot change.

Example:

"internal"

flag_key
string
required

Developer-chosen handle referenced from code, used in evaluation and results calls. Interchangeable with the returned expt_ id anywhere the API takes an experiment identifier.

Example:

"checkout_redesign_v2"

bucket_by
enum<string>

Randomization unit, and the only identity the assignment is keyed on — evaluation fails rather than falling back to another. user (default) uses subject[user_id] for account experiments and the signed-in user for internal experiments; account uses subject[account_id], so every user of an account gets the same arm; anonymous uses the anonymous id and survives sign-in. Fixed after creation.

Available options:
user,
account,
anonymous
Example:

"user"

control
object
feature_flag_only
boolean

When true, creates a binary feature flag rather than a full experiment. Feature flags expose the same evaluation API but do not collect metric results. Defaults to false.

hypothesis
string | null

Required for full experiments; rejected on feature flags. Structure it as "If we [change] for [cohort], then [measurable behavior] will [increase/decrease], resulting in [business outcome], because [evidence]. Created by [name]." Evidence should be something real — a baseline number, a funnel breakdown — not a guess, and [name] is you, not something to leave blank.

Example:

"If we send a blueprint nudge email 30 minutes after business creation, then GTV within 10 hours will increase among newly created businesses, resulting in more new business operators generating GTV within 10 hours, because operators currently land on an empty dashboard with no concrete next step. Created by Jane Doe."

name
string

Human-readable display name. Defaults to flag_key when omitted.

Example:

"Checkout Redesign V2"

targeting_rules
object[]

Rules that determine which subjects qualify for the experiment.

variants
object[]

Treatment arms to create. Users outside every arm form the implicit control group. Required unless feature_flag_only is true.

Response

experiment created

account_id
string
required

Owning account ID, or internal for Whop platform experiments.

Example:

"internal"

assignment_seed
string
required

Assignment hashes UTF-8 seed + subject ID with CRC32 modulo 100 and selects the stored end-exclusive range.

Example:

"verb_end_exp1768435200"

configuration_revision
integer
required

Revision of the serving configuration. Does not change the assignment seed.

Example:

2

control
object
required
flag_key
string
required

Developer-chosen handle referenced from code. Anywhere the API takes an experiment identifier, the expt_ id and the flag_key are interchangeable.

Example:

"verb_end_exp"

id
string
required

Unique identifier for the experiment, prefixed expt_.

Example:

"expt_xxxxxxxxxxxxxx"

name
string
required

Human-readable display name.

Example:

"Verb End"

status
enum<string>
required

Lifecycle state. draft — not yet live; active — currently running; paused — traffic paused; ended — concluded.

Available options:
draft,
active,
paused,
ended
Example:

"ended"

targeting_rules
object[]
required

Rules gating who is in the experiment at all. Conditions within a rule are AND-ed, rules are OR-ed, and exclude rules always win. Empty means everyone qualifies.

updated_at
string<date_time> | null
required
Example:

"2026-01-01T12:00:00.000Z"

variants
object[]
required

Treatment arms. Users outside every arm's allocation form the implicit control group. Weights only ever grow and arms are never removed, so a user moves from control into a treatment at most once.

bucket_by
enum<string> | null

Randomization unit — user buckets each user independently, account buckets whole accounts (every user of an account gets the same arm). null for feature flags.

Available options:
user,
account,
anonymous
Example:

"user"

created_at
string | null

When the experiment was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

created_by
string | null

ID of the user who created the experiment, prefixed user_. null for experiments created before creators were recorded.

Example:

"user_xxxxxxxxxxxxxx"

ended_at
string | null

When the experiment stopped collecting data, as an ISO 8601 timestamp. null while still running.

Example:

"2026-01-01T12:00:00.000Z"

feature_flag_only
boolean | null

true when this was created as a feature flag rather than a full experiment. Feature flags share the same evaluation API but do not collect metric results.

Example:

false

findings
string | null

What was learned and why this outcome, recorded when the experiment was ended. null until then.

Example:

"Treatment lifted conversion 8%"

hypothesis
string | null

Hypothesis for this experiment. null when none is set, and always null for feature flags.

Example:

"Users will convert more"

started_at
string | null

When the experiment began collecting data, as an ISO 8601 timestamp. null for drafts.

Example:

"2026-01-01T12:00:00.000Z"

winning_arm
string | null

The treatment that won, set when the experiment was ended. Once set, every evaluation returns this arm to every caller regardless of targeting or allocation, and no further exposures are recorded. null means control won — an ended experiment with no winning arm evaluates to control for everyone. Always null for feature flags, which simply evaluate to disabled once ended.

Example:

"treatment"