Skip to content

by Startups.Studio

Product Sites and apps Dashboard

Dashboard.create

POST /{namespace}/dashboards

Creates a Dashboard.

Noun: Dashboard
Mode: do
Event: Dashboard.created

You, to your agent

Add a dashboard to QuietCopy.

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

import { $ } from 'startup-builder'

const dashboard = await $.Dashboard.create({ scope: 'Startup' })

npx startup-builder do Dashboard.create --json '{"scope":"Startup"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Dashboard.create({ scope: 'Startup' })"
  }
}

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

Inputs

Input	Type	Required	Description
`scope`	`string`	required	What it views, such as a Studio, a Startup, a Team, or a Role.
`thing`	Thing		A Dashboard summarizes one scope, such as a Studio, a Startup, a Team, or a Role.
`app`	App		An App opens on Dashboards for the people signed in to it.

Outputs

Output	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard.

Effects

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

Dashboard.ask

Previous Page

Dashboard.delete

Next Page