> ## 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、聊天助手、Agent。

停止聊天消息生成任务。仅在 `streaming` 模式下支持。



## OpenAPI

````yaml /zh/3.11.x/develop/api/openapi_service.json post /chat-messages/{task_id}/stop
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 API 的基础 URL。替换为你部署的 API 基础 URL。
    variables:
      api_base_url:
        default: api.example.com/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - name: 对话消息
    description: 与聊天消息和交互相关的操作。
  - name: 文件操作
    description: 文件上传和预览操作。
  - name: 终端用户
    description: 终端用户信息相关操作。
  - name: 消息反馈
    description: 用户反馈操作。
  - name: 会话管理
    description: 与管理会话相关的操作。
  - name: 语音与文字转换
    description: 文字转语音和语音转文字操作。
  - name: 应用配置
    description: 获取应用设置和信息的操作。
  - name: 标注管理
    description: 与管理标注直接回复相关的操作。
  - name: 人工介入
    description: 暂停等待人工输入的工作流恢复操作。
  - name: 工作流运行
    description: 用于执行和管理工作流的操作。
  - name: 文本生成消息
    description: 文本生成相关操作。
  - name: 知识库
    description: 用于管理知识库的操作，包括创建、配置和检索。
  - name: 文档
    description: 用于在知识库中创建、更新和管理文档的操作。
  - name: 分段
    description: 用于管理分段和子分段的操作。
  - name: 元数据
    description: 用于管理知识库元数据字段和文档元数据值的操作。
  - name: 标签
    description: 用于管理知识库标签和标签绑定的操作。
  - name: 模型
    description: 用于获取可用模型的操作。
  - name: 知识流水线
    description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /chat-messages/{task_id}/stop:
    post:
      tags:
        - 对话消息
      summary: 停止响应
      description: |-
        **适用于**：Chatflow、聊天助手、Agent。

        停止聊天消息生成任务。仅在 `streaming` 模式下支持。
      operationId: stopBasicChatMessageGenerationCn
      parameters:
        - name: task_id
          in: path
          required: true
          description: >-
            任务 ID，来自
            [发送对话消息](/zh/3.11.x/develop/api/chat-messages/send-chat-message)
            的流式事件。
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - user
              properties:
                user:
                  type: string
                  description: >-
                    终端用户标识，由你的应用定义，需在应用内唯一。必须与发送原始消息时的 `user`
                    一致；不一致时停止不会生效，但仍返回成功。参见
                    [终端用户身份](/zh/3.11.x/develop/api/guides/end-user-identity)。
            examples:
              example:
                summary: 请求示例
                value:
                  user: abc-123
      responses:
        '200':
          $ref: '#/components/responses/SuccessResult'
        '400':
          description: |-
            - `not_chat_app` : 应用模式与 API 路由不匹配。
            - `invalid_param` : 缺少必填的 `user` 字段。
          content:
            application/json:
              examples:
                not_chat_app:
                  summary: not_chat_app
                  value:
                    status: 400
                    code: not_chat_app
                    message: Please check if your app mode matches the right API route.
                invalid_param:
                  summary: invalid_param
                  value:
                    status: 400
                    code: invalid_param
                    message: Arg user must be provided.
components:
  responses:
    SuccessResult:
      description: 操作成功。
      content:
        application/json:
          schema:
            type: object
            properties:
              result:
                type: string
                description: 操作结果，固定为 `success`。
          examples:
            success:
              summary: 响应示例
              value:
                result: success
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API
        Key，知识库接口使用知识库 API
        Key（[快速开始](/zh/3.11.x/develop/api/guides/get-started)）。


        API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。

````