Skip to content

by Startups.Studio

Product Build and ship Monitor

Monitor.create

POST /{namespace}/monitors

Creates a Monitor.

Noun: Monitor
Mode: do
Event: Monitor.created

You, to your agent

Add a monitor to PetPantry.

curl -X POST https://api.sb/petpantry.shop/monitors \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"internal","target":"/health"}'

import { $ } from 'startup-builder'

const monitor = await $.Monitor.create({ kind: 'internal', target: '/health' })

npx startup-builder do Monitor.create --json '{"kind":"internal","target":"/health"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Monitor.create({ kind: 'internal', target: '/health' })"
  }
}

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

Inputs

Input	Type	Required	Description
`kind`	`string`	required	`internal` watches the Startup’s own routes and jobs; `outside` watches the world, such as a rival’s price.
`target`	`string`	required	What it checks: a route, a Domain, a Keyword, a prompt or a page.
`every`	`string`		How often it runs, such as `1m` or `1d`.

Outputs

Output	Type	Required	Description
`monitor`	Monitor	required	The Monitor.

Effects

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

Monitor.check

Previous Page

Monitor.get

Next Page