Skip to content

by Startups.Studio

Readout.create

POST /{namespace}/readouts

Creates a Readout.

Noun: Readout
Mode: do
Event: Readout.created

You, to your agent

Add a readout to TutorLoop.

curl -X POST https://api.sb/tutorloop.com/readouts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":1,"n":1,"readability":"A"}'

import { $ } from 'startup-builder'

const readout = await $.Readout.create({ value: 1, n: 1, readability: 'A' })

npx startup-builder do Readout.create --json '{"value":1,"n":1,"readability":"A"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Readout.create({ value: 1, n: 1, readability: 'A' })"
  }
}

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

Inputs

Input	Type	Required	Description
`value`	`number`	required	The Metric’s value for the Variant.
`n`	`integer`	required	How many exposed units it counts.
`interval`	`json`		The low and high bounds of the estimate.
`readability`	`string`	required	One of `A`, `B`, `C`, or `inadmissible`: how far the number can be trusted.
`pooled`	`boolean`		True when exposures from sibling Startups or earlier Portfolio results are pooled in.
`experiment`	Experiment		The Experiment the result belongs to; the learn step drafts the next Variant from it.
`variant`	Variant		The Variant the number describes.

Outputs

Output	Type	Required	Description
`readout`	Readout	required	The Readout.

Effects

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

Readout

Previous Page

Readout.delete

Next Page