Skip to content

by Startups.Studio

Play.create

POST /{namespace}/plays

Creates a Play.

Noun: Play
Mode: do
Event: Play.created

You, to your agent

Add a play to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/plays \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"family":"demand"}'

import { $ } from 'startup-builder'

const play = await $.Play.create({ family: 'demand' })

npx startup-builder do Play.create --json '{"family":"demand"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Play.create({ family: 'demand' })"
  }
}

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

Inputs

Input	Type	Required	Description
`family`	`string`	required	The job it does, such as `demand`, `retention`, or `pricing`.
`cost`	`money`		What one run costs.
`cohort`	`json`		The Portfolio query a Studio rolls it out to.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.

Outputs

Output	Type	Required	Description
`play`	Play	required	The Play.

Effects

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

Play.apply

Previous Page

Play.delete

Next Page