Skip to content

by Startups.Studio

Growth Experiment

Experiment.start

POST /{namespace}/experiments/{experiment}/start

Start opens an Experiment, splits traffic across its variants, and begins measuring its primary and guardrail Metrics.

Noun: Experiment
Mode: do
Event: Experiment.started

You, to your agent

Start the latest experiment.

curl -X POST https://api.sb/patentpad.com/experiments/experiment_1/start \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const experiment = await $.Experiment.start({ experiment: 'experiment_1' })

npx startup-builder do Experiment.start --json '{"experiment":"experiment_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Experiment.start({ experiment: 'experiment_1' })"
  }
}

Inputs

Input	Type	Required	Description
`experiment`	Experiment	required	The Experiment to open.

Outputs

Output	Type	Required	Description
`experiment`	Experiment	required	The running Experiment.

Effects

Emits Experiment.started.
Performed by the Strategist.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Experiment.start
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Experiment.start
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Experiment.start

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Experiment.list

Previous Page

Exposure

Next Page