Skip to content

by Startups.Studio

Core grammar Action

Action.cancel

POST /{namespace}/actions/{action}/cancel

Cancel stops a pending Action, sets its status to `canceled`, and runs its compensation.

Noun: Action
Mode: do
Event: Action.canceled

You, to your agent

Cancel the latest action.

curl -X POST https://api.sb/petpantry.shop/actions/action_1/cancel \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const action = await $.Action.cancel({ action: 'action_1' })

npx startup-builder do Action.cancel --json '{"action":"action_1"}'

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

Cancel stops a pending Action, sets its status to canceled, and runs its compensation.

Inputs

Input	Type	Required	Description
`action`	Action	required	The pending Action.
`reason`	`text`		Why it stops.

Outputs

Output	Type	Required	Description
`action`	Action	required	The canceled Action.

Effects

Emits Action.canceled.
Performed by the Risk Analyst.
Moves the Noun it acted on to its canceled state, when the Noun has one.

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.cancel
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Action.cancel

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

Previous Page

Action.create

Next Page