Skip to main content
The SuperFlow API lets you manage the full lifecycle of a SuperFlow workflow programmatically. It covers four resource groups: workflow definitions (create, read, update, delete, and share), executions (run, monitor, pause, resume, terminate, and rerun), schedules (recurring cron-driven triggers), and approvals (human-in-the-loop requests raised by running workflows).

​
Base URL

All endpoints in this section are served from the following base URL.

​
Authentication

Every endpoint requires your Lyzr API key in the x-api-key header.
The execute endpoint additionally accepts an X-Webhook-Secret header in place of an API key when the workflow has a webhook trigger configured. See Execute Workflow for details.

​
Typical flow

A common integration follows four steps. First, create a workflow with Create Workflow or build it visually in Studio; the workflow graph itself is a JSON document described in the flow_data reference. Second, start a run with Execute Workflow, which returns an execution_id immediately. Third, track progress by polling Get Execution Status or by subscribing to the live event stream. Fourth, if the workflow contains a human-in-the-loop node, resolve the pending request with Resolve Approval so the run can continue.

​
Access control

Workflows are owned by the API key that created them and can be shared with other users at read, write, or execute access levels. List endpoints return resources you own plus resources shared with you. Destructive operations such as deleting a workflow or removing its shares are restricted to the owner.

​
Next steps

If you are new to SuperFlow, start with the SuperFlow overview and the quickstart to build your first workflow, then return here to automate it over REST.