Skip to content

by Startups.Studio

Growth Experiment

Experiment.create

POST /{namespace}/experiments

Creates an Experiment.

Noun: Experiment
Mode: do
Event: Experiment.created

You, to your agent

Add an experiment to PatentPad.

curl -X POST https://api.sb/patentpad.com/experiments \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"variants":{}}'

import { $ } from 'startup-builder'

const experiment = await $.Experiment.create({ variants: {} })

npx startup-builder do Experiment.create --json '{"variants":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Experiment.create({ variants: {} })"
  }
}

Create makes a new Experiment from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`variants`	`json`	required	The variants and their split.
`decision`	`string`		One of `ship`, `kill`, or `iterate`.
`hypothesis`	Hypothesis		Each Experiment settles one Hypothesis; many Experiments test one Hypothesis in turn.

Outputs

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

Effects

Emits Experiment.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
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.create

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.conclude

Previous Page

Experiment.get

Next Page