Skip to main content
POST
Launch a prepared debug attempt
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/workflows/launchDebugAttempt Queues a prepared attempt. The node runs with the attempt’s effect plan: simulated effects stay simulated. Poll getDebugAttempt for its status, output and cost. Preparing and launching run the node as a person: debug execution decides governance and credential access (credentials:use) for the attempt’s creator. So these need a Personal key; an External App or a platform key is 403 with personRequired: true.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:use, and the credential’s scopes must also reach workflows:read (a 403 naming it otherwise). Both are decided at the workflow’s home org unit. A debug attempt is personal, as in the Console: you debug drafts you created and read attempts you started. With a Personal key that is its owner; an External App or a platform key is its own creator (externalApp:<id>, apiKey:<id>). When draft debugging (workflow_debug_execution) is off for you (a Personal key’s owner) or for the deployment (an app or platform key), the route answers 409 conflict.

Headers

string
required
Required. The launch’s own key: the attempt is launched at most once for it. Within 24 hours a same-key retry returns the recorded answer, only while you still own the attempt (otherwise 409 idempotency_result_unavailable); after that, a repeat answers idempotent: true without running the node again. See Idempotency.

Body

string
required
The prepared attempt’s id.
string
required
The planHash the preparation returned.

Responses

202 with data.attemptId, data.status (queued) and data.idempotent.

Errors

Example

Authorizations

Authorization
string
header
required

A Personal key (fmcp_…), bound to the person who created it, or an interactive MCP sign-in that resolves to one. Pass as Authorization: Bearer <key>. It acts for that person, under their role grants narrowed by its scopes; an operation that acts for a person admits only this kind.

Headers

Idempotency-Key
string
required

Required. The launch's intent key: the attempt is launched at most once for it. Within 24 hours a repeat returns the recorded answer; after that, a repeat answers idempotent: true.

Required string length: 1 - 255

Path Parameters

attemptId
string
required

The prepared attempt's id.

Minimum string length: 1

Body

application/json
planHash
string
required

The planHash the preparation returned.

Minimum string length: 1

Response

The queued attempt

data
object
required
meta
object
required