Skip to content

by Startups.Studio

Core grammar Process

Process.pause

POST /{namespace}/processes/{process}/pause

Pause stops a Process from starting new Actions; Actions already in progress finish.

Noun: Process
Mode: do
Event: Process.paused

You, to your agent

Pause the latest process.

curl -X POST https://api.sb/shiftnote.app/processes/process_1/pause \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const process = await $.Process.pause({ process: 'process_1' })

npx startup-builder do Process.pause --json '{"process":"process_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Process.pause({ process: 'process_1' })"
  }
}

Inputs

Input	Type	Required	Description
`process`	Process	required	The Process to pause.

Outputs

Output	Type	Required	Description
`process`	Process	required	The paused Process.

Effects

Emits Process.paused.
Performed by the Founder.
Two-way: it runs at once, in the try, send and do modes.
Holds its Triggers until the Process is enabled again.

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

Process.list

Previous Page

Process.update

Next Page