> ## 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。 停止运行中的任务。 停止操作是幂等的，也不会透露任务的任何信息：任务已结束、不存在或属于其他 API 密钥时，同样返回 `{"result": "success"}`，但不会真的停止任何任务。 **对应的标准 API 接口**：[停止响应](/zh/3.13.x/develop/api/chat-messages/stop-chat-message-generation)。两者契约相同，只有认证和可用性相关的错误码不同。 ## OpenAPI ````yaml /zh/3.13.x/develop/api/openapi_service.json post /v2/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: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。 - name: 部署环境 description: >- 部署环境通过 `v2` 基础 URL 提供的接口。部署环境只提供本组中的接口，调用其他路径会返回 `404 not_found`。认证方式和错误码与标准服务 API 不同，部署环境以本组页面为准。 paths: /v2/chat-messages/{task_id}/stop: post: tags: - 部署环境 summary: 停止响应 description: >- **适用于**：Chatflow。 停止运行中的任务。 停止操作是幂等的，也不会透露任务的任何信息：任务已结束、不存在或属于其他 API 密钥时，同样返回 `{"result": "success"}`，但不会真的停止任何任务。 **对应的标准 API 接口**：[停止响应](/zh/3.13.x/develop/api/chat-messages/stop-chat-message-generation)。两者契约相同，只有认证和可用性相关的错误码不同。 operationId: stopDeployedChatMessageCn parameters: - name: task_id in: path required: true description: >- 任务 ID，来自 [发送对话消息](/zh/3.13.x/develop/api/deployed-environments/send-chat-message) 的响应或流式事件。 schema: type: string format: uuid requestBody: required: false content: application/json: schema: type: object properties: user: type: string description: >- 终端用户标识，由你的应用定义，需在应用内唯一。此处仅为兼容保留，停止操作只依据 API 密钥和任务鉴权。参见 [终端用户身份](/zh/3.13.x/develop/api/guides/end-user-identity)。 examples: example: summary: 请求示例 value: user: abc-123 responses: '200': description: 已接受停止请求。 content: application/json: schema: type: object properties: result: type: string description: 固定为 `success`。 examples: ok: summary: 响应示例 value: result: success '400': description: '`invalid_request`：停止请求的工作空间、应用或环境与部署不匹配。请让管理员检查部署路由。' content: application/json: examples: invalid_request: summary: invalid_request value: code: invalid_request message: runtime route identity does not match task identity status: 400 '401': description: |- - `token_invalid`：API 密钥缺失、格式错误或无法识别。 - `unauthorized`：API 密钥已撤销。 - `runtime_identity_invalid`：请求携带的身份签名与该任务不匹配，重新发起请求即可。 content: application/json: examples: token_invalid: summary: token_invalid value: code: token_invalid message: invalid api token status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 runtime_identity_invalid: summary: runtime_identity_invalid value: code: runtime_identity_invalid message: runtime identity is invalid status: 401 '403': description: '`forbidden`：该应用在 **访问点** 中关闭了 API 访问。' content: application/json: examples: forbidden: summary: forbidden value: code: forbidden message: The app's API service has been disabled. status: 403 '404': description: '`not_found`：`task_id` 不是标准的小写 UUID。' content: application/json: examples: not_found: summary: not_found value: code: not_found message: unsupported appdeploy service api endpoint status: 404 '503': description: |- - `deployment_undeployed`：该应用已从此环境下线。 - `deployment_not_ready`：部署正在进行中，稍后重试。 - `apprunner_not_deployed`：该环境不可用，例如环境正在删除。 - `enterprise_unavailable`：平台侧的路由服务暂时不可用，稍后重试。 - `service_not_ready`：环境未能执行停止，例如此任务的版本已不再部署在该环境中，稍后重试。 content: application/json: examples: deployment_undeployed: summary: deployment_undeployed value: code: deployment_undeployed message: deployment is not deployed status: 503 deployment_not_ready: summary: deployment_not_ready value: code: deployment_not_ready message: deployment is in progress status: 503 apprunner_not_deployed: summary: apprunner_not_deployed value: code: apprunner_not_deployed message: apprunner not deployed for this environment status: 503 enterprise_unavailable: summary: enterprise_unavailable value: code: enterprise_unavailable message: enterprise routing service unavailable status: 503 service_not_ready: summary: service_not_ready value: code: service_not_ready message: task revision is not assigned to this runner status: 503 servers: - url: https://{deployed_api_base_url} description: 所有部署环境共用的基础 URL，即把标准服务 API 地址中的 `/v1` 换成 `/v2`。 variables: deployed_api_base_url: default: api.example.com description: >- 打开应用的 **访问点** 标签页，从任一部署环境的 **后端服务 API** 卡片复制完整 URL，再去掉开头的 `https://` 和末尾的 `/v2`。 components: securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API_KEY description: >- 每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API Key，知识库接口使用知识库 API Key（[快速开始](/zh/3.13.x/develop/api/guides/get-started)）。 API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。 ````