Sovereign Platform is in pre-launch alpha.
Not yet available to purchase. Sign up for our mailing list for upcoming launch dates.
Loading documentation, please wait.
Sovereign Platform is in pre-launch alpha.
Not yet available to purchase. Sign up for our mailing list for upcoming launch dates.
Sovereign Workflows provides a REST API for programmatic access to all platform capabilities. You can trigger workflows, check execution status, manage schedules, and more — all through standard HTTP requests.
Your deployment includes built-in interactive API documentation via Swagger UI, available at:
http://your-engine-host:5003/swagger
Or through the reverse proxy:
http://your-host:4723/swagger
Swagger UI lets you browse all available endpoints, see request/response schemas, and test API calls directly from your browser.
Swagger as Your Reference
The Swagger UI on your deployment is the most accurate and up-to-date API reference, as it reflects the exact endpoints and schemas available on your running instance. Use it as your primary API reference.
To disable Swagger in production (if you do not want to expose the API documentation publicly):
Swagger__Enabled=false
All API requests require authentication. Include a Bearer token in the Authorization header:
Authorization: Bearer <your-access-token>
Obtain an access token through the OAuth 2.1 flow provided by the Auth Service. See Authentication Setup for details on configuring authentication.
The API is organized into several areas:
Create, update, publish, and manage workflow definitions. Workflows are the core resource — everything else (executions, schedules, configurations) references a workflow.
Trigger workflow executions, check their status, cancel running executions, and retrieve step-level details. This is the most commonly used API surface for integrations.
Create cron-based schedules to run workflows automatically. Manage schedule lifecycle (enable, disable, update, delete).
Create saved input parameter sets for workflows. Configurations can be referenced by schedules and manual execution requests.
Query the available connector catalog and action registry. Useful for building dynamic UIs or discovering what actions are available in your deployment.
Manage human approval requests for workflows with Human Gate nodes. Approve, reject, or query pending approval requests.
Manage credential connections to external services. Initiate OAuth flows, check connection status, and manage connection policies.
Create and manage webhook triggers. Each webhook generates a unique URL that external systems can call to start a workflow.
POST /api/v1/workflows/{workflowId}/execute
Content-Type: application/json
Authorization: Bearer <token>
{
"trigger": { "customer_id": "12345" },
"vars": { "environment": "production" }
}
Returns the execution ID for status tracking.
GET /api/v1/executions/{executionId}
Authorization: Bearer <token>
Returns the execution status, step details, timing, and outputs.
GET /api/v1/executions?workflowId={workflowId}&status=Failed&limit=10
Authorization: Bearer <token>
Returns a filtered list of executions.