API Reference

The workflow engine exposes a REST API on port 3030 (default). The Swagger UI at http://localhost:3030/api is the authoritative, always-up-to-date API reference with request/response schemas and a "Try it out" feature.

Endpoint Groups

Group	Base Path	Purpose
Workflow Definitions	/workflow-definition	Create, update, list, and delete workflow definitions
Workflow Executions	/workflow-execution	Trigger, monitor, and abort workflow executions
Blackboard	/blackboard	Job polling and result submission (used by workers)
Function Blocks	/function-blocks	Registration and lookup of function blocks
Workers	/workers	Worker registration, heartbeat, and lifecycle
Health & Version	/health, /version	Probes, version info, and SDK compatibility
Schema	/schema	Workflow JSON Schema (for IDE validation)

Common Operations

Deploy a workflow

curl -X POST http://localhost:3030/workflow-definition \
  -H "Content-Type: application/json" \
  -d '{"workflow": { ... }}'

The request body wraps the workflow definition in a workflow key (as JSON). See Your First Workflow for a complete walkthrough.

Execute a workflow

curl -X POST http://localhost:3030/workflow-execution \
  -H "Content-Type: application/json" \
  -d '{
    "workflow": "wf.example.neops.io/hello_world:1.0.0",
    "executeOnParameters": { "ids": [1, 2, 3] },
    "parameters": {}
  }'

Field	Description
workflow	SemVer identifier (package/name:version)
executeOnParameters.ids	Entity IDs to execute on (from CMS). Omit for global workflows
parameters	Runtime parameter values matching the workflow's parameterSchema

Health check

curl http://localhost:3030/health/
# {"status": "ok"}

Get the workflow schema

curl http://localhost:3030/schema/

Returns the full RootWorkflow JSON Schema. Point your IDE at this endpoint for live validation -- see IDE Setup.

Swagger UI

For the full list of endpoints, request/response schemas, and interactive testing, open the Swagger UI (requires a running engine).