> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperFlow API

> Manage SuperFlow workflows, executions, schedules, and human-in-the-loop approvals over REST.

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.

```text theme={null}
https://inference.studio.lyzr.ai/api
```

## Authentication

Every endpoint requires your Lyzr API key in the `x-api-key` header.

```bash theme={null}
curl https://inference.studio.lyzr.ai/api/workflows \
  -H "x-api-key: YOUR_API_KEY"
```

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](/enterprise/api/superflow/executions/execute) for details.

## Typical flow

A common integration follows four steps. First, create a workflow with [Create Workflow](/enterprise/api/superflow/workflows/create) or build it visually in Studio; the workflow graph itself is a JSON document described in the [flow\_data reference](/enterprise/api/superflow/flow-data). Second, start a run with [Execute Workflow](/enterprise/api/superflow/executions/execute), which returns an `execution_id` immediately. Third, track progress by polling [Get Execution Status](/enterprise/api/superflow/executions/get) or by subscribing to the live [event stream](/enterprise/api/superflow/executions/stream-events). Fourth, if the workflow contains a human-in-the-loop node, resolve the pending request with [Resolve Approval](/enterprise/api/superflow/approvals/resolve) 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](/enterprise/agent-studio/superflow/overview) and the [quickstart](/enterprise/agent-studio/superflow/quickstart) to build your first workflow, then return here to automate it over REST.
