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

# Workflow App API

> API for Workflow apps, covering workflow execution, run control and streaming, Human Input pauses, and run history

[Workflow apps](https://enterprise-docs.dify.ai/en/3.13.x/use/build/workflow-chatflow.md) run in `workflow` mode, executing the published workflow once per call and returning its outputs. There's no conversation state between calls, so each run is independent of any previous one.

> [!NOTE]
>
> Authentication, the base URL, and the `user` field that scopes end-user data are covered in [Get Started](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/guides/get-started.md) and [End User Identity](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/guides/end-user-identity.md).

## Run a Workflow

* **[Run Workflow](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/run-workflow.md)**: execute the app's currently published workflow with the input variables you provide.

  Streaming mode delivers events live as nodes execute; blocking mode returns once the run finishes.
* **[Run Workflow by ID](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/run-workflow-by-id.md)**: execute a specific published version instead, identified by the `workflow_id` from an earlier run response or run detail lookup.

## Follow and Control a Run

Whichever mode you run in, the response carries two IDs: `task_id` controls the run while it's active, and `workflow_run_id` identifies the persisted record afterward.

* **[Stop Workflow Task](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/stop-workflow-task.md)**: cancel an active run by its `task_id`. Works in streaming mode only; a blocking call has already finished by the time it returns.
* **[Stream Workflow Events](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/stream-workflow-events.md)**: resume a run's event stream from its `workflow_run_id` after a dropped connection or a pause.

  Pass `include_state_snapshot=true` to replay the status of already-executed nodes first, or `continue_on_pause=true` to stay open across multiple Human Input pauses.

## Pause for Human Input

When a run reaches a [Human Input node](https://enterprise-docs.dify.ai/en/3.13.x/use/nodes/human-input) whose delivery method is web app, complete the pause over the API:

**1. Listen for the pause**

The run's event stream emits `human_input_required` carrying a `form_token` and the run's `workflow_run_id`, then ends with the `workflow_paused` event.

**2. Fetch the form**

Load the form's contents with [Get Human Input Form](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/human-input/get-human-input-form.md), using the `form_token`.

**3. Submit the response**

Send the recipient's input with [Submit Human Input Form](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/human-input/submit-human-input-form.md). Submitting resumes the run.

**4. Resume the stream**

Open a new stream with [Stream Workflow Events](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/stream-workflow-events.md), using the `workflow_run_id` from the paused stream, and follow the remaining events through to the run's finish.

For file-attached submissions and the full event sequence, see the [Human Input Flow](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/guides/human-input-flow.md) guide.

## Inspect Past Runs

* **[Get Workflow Run Detail](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/get-workflow-run-detail.md)**: a run's status and outputs, by its `workflow_run_id`.
* **[List Workflow Logs](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/list-workflow-logs.md)**: run-level summaries covering status, token usage, step count, and timing, rather than a node-by-node execution log; filter by keyword, status, date range, or who triggered the run.

For node-level events, stream the run instead of listing its logs: call [Run Workflow](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/run-workflow.md) in streaming mode for a run you're starting, or [Stream Workflow Events](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/workflow-runs/stream-workflow-events.md) for one already in progress.

## Work with Files

* **[Upload File](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/files/upload-file.md)**: upload an image, document, audio, or video file, then pass the returned `id` as `upload_file_id` in a file-type input variable when you run the workflow. Files are scoped to the uploading end user.
* **[Get End User Info](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/end-users/get-end-user-info.md)**: look up an end user's details from an end-user ID, such as the `created_by` in the Upload File response.

## Transcribe and Synthesize Speech

* **[Convert Audio to Text](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/audio/convert-audio-to-text.md)**: transcribe an uploaded audio file (MP3, M4A, WAV, AMR, or MPGA, up to 30 MB) so end users can speak an input value instead of typing it.
* **[Convert Text to Audio](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/audio/convert-text-to-audio.md)**: synthesize a workflow's text output back into speech.

## Retrieve App Info and Settings

* **[Get App Info](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/applications/get-app-info.md)**: the app's name, description, tags, and mode.
* **[Get App Parameters](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/applications/get-app-parameters.md)**: the fields your calls send in `inputs` (names, types, defaults) plus the app's feature switches—the basis for building requests or a client UI.
* **[Get App Meta](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/applications/get-app-meta.md)**: tool icons and other configuration metadata.
* **[Get App WebApp Settings](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/applications/get-app-webapp-settings.md)**: the web app's site configuration, theme, and customization options.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.