Skip to content

by Startups.Studio

Core grammar Action

Action.pause

POST /{namespace}/actions/{action}/pause

Pause holds a pending Action past the close of its delay window until a watcher resumes, redirects, or cancels it.

Noun: Action
Mode: do
Event: Action.paused

You, to your agent

Pause the latest action.

curl -X POST https://api.sb/tutorloop.com/actions/action_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const action = await $.Action.pause({ action: 'action_1', reason: 'Example reason' })

npx startup-builder do Action.pause --json '{"action":"action_1","reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Action.pause({ action: 'action_1', reason: 'Example reason' })"
  }
}

Inputs

Input	Type	Required	Description
`action`	Action	required	The pending Action.
`reason`	`text`	required	Why it must wait.
`until`	`datetime`		When the pause escalates to the Role above if nobody resolves it; defaults to one business day.

Outputs

Output	Type	Required	Description
`action`	Action	required	The paused Action, still `pending`.

Effects

Emits Action.paused.
Records a Decision with the reason.
Escalates to the Role above the watcher when until passes unresolved.

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.	Action.pause

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

Action.list

Previous Page

Action.redirect

Next Page