> ## 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.

# Chatflow App API

> API for Chatflow apps, covering chat messages, workflow-level streaming, conversation management, and Human Input pauses

[Chatflow apps](https://enterprise-docs.dify.ai/en/3.13.x/use/build/workflow-chatflow.md) run in `advanced-chat` mode, streaming workflow-level events (node starts, finishes, iterations, and pauses) alongside the reply. Previous turns persist as context, so later messages can reference earlier ones.

> [!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).

## Send Messages and Stream Replies

* **[Send Chat Message](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/chat-messages/send-chat-message.md)**: send a query to your Chatflow app. Streaming mode carries workflow and node events alongside the answer text; blocking mode returns once the run finishes.
* **[Stop Chat Message Generation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/chat-messages/stop-chat-message-generation.md)**: interrupt a streaming reply before it finishes.
* **[Get Next Suggested Questions](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/chat-messages/get-next-suggested-questions.md)**: propose follow-up questions after a reply completes, based on the conversation so far.

## Manage Conversations

* **[List Conversations](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/list-conversations.md)**: the current user's conversations, ordered by most recent activity.
* **[List Conversation Messages](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/list-conversation-messages.md)**: one conversation's message history, for a scrolling chat UI.
* **[Rename Conversation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/rename-conversation.md)**: set or auto-generate a display name.
* **[Delete Conversation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/delete-conversation.md)**: remove a conversation.
* **[List Conversation Variables](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/list-conversation-variables.md)**: read the values the session persists across turns.
* **[Update Conversation Variable](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/conversations/update-conversation-variable.md)**: change one of those values directly.

## Handle 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 for [Send Chat Message](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/chat-messages/send-chat-message.md) to reference. Files are scoped to the uploading end user.
* **[Download File](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/files/download-file.md)**: preview or download an uploaded file, as long as it belongs to a message in your app.
* **[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 their input 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 reply back into speech.

## 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 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 the final answer.

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 Workflow 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 the `workflow_run_id` that appears in the workflow and node events streamed alongside a chat reply.
* **[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.

## 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.

## Collect Feedback and Annotations

* **[Submit Message Feedback](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/feedback/submit-message-feedback.md)**: end users rate a reply as `like` or `dislike`, with an optional text comment.
* **[List App Feedbacks](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/feedback/list-app-feedbacks.md)**: every feedback submitted across the app, from both end users and admins.

Annotations pair a question with a fixed answer that the app returns directly instead of generating a new response:

* **[Create Annotation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/create-annotation.md)**, **[List Annotations](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/list-annotations.md)**, **[Update Annotation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/update-annotation.md)**, **[Delete Annotation](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/delete-annotation.md)**: manage the annotation set.
* **[Configure Annotation Reply](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/configure-annotation-reply.md)**: turn annotation matching on or off. The change runs asynchronously.
* **[Get Annotation Reply Job Status](https://enterprise-docs.dify.ai/en/3.13.x/develop/api/annotations/get-annotation-reply-job-status.md)**: poll with the returned job ID to confirm the change finished.


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