Skip to content

by Startups.Studio

Product Sites and apps Flow

Flow.create

POST /{namespace}/flows

Creates a Flow.

Noun: Flow
Mode: do
Event: Flow.created

You, to your agent

Add a flow to Kiln Bakery with a persona and an offer and a dashboard.

curl -X POST https://api.sb/kilnbakery.com/flows \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"persona":"persona_1","offer":"offer_1","steps":["dashboard_1"]}'

import { $ } from 'startup-builder'

const flow = await $.Flow.create({ persona: 'persona_1', offer: 'offer_1', steps: ['dashboard_1'] })

npx startup-builder do Flow.create --json '{"persona":"persona_1","offer":"offer_1","steps":["dashboard_1"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flow.create({ persona: 'persona_1', offer: 'offer_1', steps: ['dashboard_1'] })"
  }
}

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

Inputs

Input	Type	Required	Description
`persona`	Persona	required	The Persona it guides; its Role decides which Verbs each step offers.
`offer`	Offer	required	The Offer whose activation Event ends the Flow; time to value reads from first step to that Event.
`steps`	list of Dashboard	required	The Dashboards in order, first run first, each ending in the Verb that opens the next.
`app`	App		The Flows an App runs on first sign-in, one per Persona and Offer, each ending at the activation Event.

Outputs

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

Effects

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

Flow

Previous Page

Flow.delete

Next Page