Skip to content

by Startups.Studio

Play.apply

POST /{namespace}/plays/{play}/apply

Apply runs a Play across a Portfolio cohort, one wave at a time, measured as an Experiment.

Noun: Play
Mode: do
Event: Play.applied

You, to your agent

Apply the latest play.

curl -X POST https://api.sb/kilnbakery.com/plays/play_1/apply \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cohort":"Example cohort"}'

import { $ } from 'startup-builder'

const { experiment, play } = await $.Play.apply({ play: 'play_1', cohort: 'Example cohort' })

npx startup-builder do Play.apply --json '{"play":"play_1","cohort":"Example cohort"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Play.apply({ play: 'play_1', cohort: 'Example cohort' })"
  }
}

Inputs

Input	Type	Required	Description
`play`	Play	required	The Play to run.
`cohort`	`string`	required	The Portfolio query that selects the Startups.

Outputs

Output	Type	Required	Description
`experiment`	Experiment	required	The Experiment that measures the rollout.
`play`	Play	required	The Play applied.

Effects

Emits Play.applied.
Performed by the Marketing Lead.
Tags every write with the Play, so one revert undoes the rollout.

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.	Play.apply
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.	Play.apply

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

Play

Previous Page

Play.create

Next Page