Skip to main content
POST
Stop the Procedure Builder's running turn
Asks the version’s running Builder turn to stop after its current step; a tool already running finishes it. requested is false, and nothing changes, when no turn is running. The turn stopped is always the version’s own. You need procedures:write at the version’s home (a version with no home: the platform scope); a version out of reach is the same 404 resource_missing as a missing one. Every credential kind may call it.

Idempotency

With an Idempotency-Key, a same-key repeat within 24 hours returns the recorded answer, without starting another turn, only while you still hold procedures:write at the version’s home; otherwise 409 idempotency_result_unavailable.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without starting another turn.

Required string length: 1 - 255

Path Parameters

procedureId
string
required

The procedure family's id (its slug).

Minimum string length: 1

Body

application/json
version
string
required

The semver version.

Minimum string length: 1

Response

Success

data
object
required
meta
object
required