Skip to main content
POST
/
v1
/
workflows
/
execute
Execute a workflow
curl --request POST \
  --url https://api.beltic.com/v1/workflows/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowId": "<string>",
  "workflow": {},
  "useDraftState": true,
  "options": {
    "executionId": "<string>",
    "input": {},
    "environmentVariables": {},
    "workflowVariables": {},
    "maxParallelNodes": 2
  },
  "parentExecutionId": "<string>",
  "callChain": [
    "<string>"
  ]
}
'
{
  "success": true,
  "output": {},
  "executionId": "<string>",
  "error": "<string>",
  "pausePoints": [
    {}
  ],
  "logs": [
    {}
  ],
  "finalState": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.beltic.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Beltic-issued JWT bearer token.

Body

application/json
workflowId
string
required

Workflow ID to execute.

workflow
object

Optional inline workflow state. When provided, replaces the persisted workflow definition for this run.

useDraftState
boolean

When true, run the workflow's draft state instead of the latest deployed version. Defaults to false.

options
object

Runtime options for an execution.

runFromBlock
object

Partial re-run descriptor. The referenced execution must already exist; raw source-state injection is intentionally unavailable to public callers.

parentExecutionId
string

Parent execution ID when this run is a subworkflow.

callChain
string[]

Ancestor workflow IDs leading to this run. Used for cycle detection in subworkflows.

Minimum string length: 1

Response

Execution reached a terminal state.

Result of an execution. Returned by POST /v1/workflows/execute with status 200 (completed/failed) or 202 (paused).

success
boolean
required
output
object
required

Normalized block output keyed by block ID.

executionId
string
required
error
string

Error message when the run did not complete successfully.

status
enum<string>

Terminal or paused status of a workflow execution.

Available options:
completed,
failed,
paused,
cancelled
pausePoints
object[]

Active pause points when the run is paused awaiting external input.

logs
object[]

Block-level execution logs.

finalState
object

Compact snapshot of final execution state. Populated on successful completion to support future partial (run-from-block) re-runs.