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

# 获取工作流执行情况

> 根据工作流执行 ID 获取工作流任务的当前执行结果。



## OpenAPI

````yaml /zh/api-reference/openapi_chatflow.json get /workflows/run/{workflow_run_id}
openapi: 3.0.1
info:
  title: 工作流编排对话型应用 API (对话流 API)
  description: >-
    对话流应用支持会话持久化，允许将之前的聊天记录作为响应的上下文。对话流应用使用 `advanced-chat`
    模式，提供工作流级别的流式事件，用于详细的执行追踪，包括节点开始、完成、迭代和工作流生命周期。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: 工作流编排对话型应用 API 的基础 URL。自部署时，替换为你的 API 基础 URL。
    variables:
      api_base_url:
        default: api.dify.ai/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: 暂停等待人工输入的工作流恢复操作。
paths:
  /workflows/run/{workflow_run_id}:
    get:
      tags:
        - 对话流
      summary: 获取工作流执行情况
      description: 根据工作流执行 ID 获取工作流任务的当前执行结果。
      operationId: getChatflowWorkflowRunDetailZh
      parameters:
        - name: workflow_run_id
          in: path
          required: true
          description: 工作流运行 ID，可从流式事件或消息元数据中获取。
          schema:
            type: string
      responses:
        '200':
          description: 成功获取工作流运行详情。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunDetailResponse'
              examples:
                workflowRunDetail:
                  summary: 响应示例
                  value:
                    id: fb47b2e6-5e43-4f90-be01-d5c5a088d156
                    workflow_id: 7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345
                    status: succeeded
                    inputs:
                      query: Translate this to French
                    outputs:
                      result: Traduisez ceci en francais
                    error: null
                    total_steps: 3
                    total_tokens: 150
                    created_at: 1705407629
                    finished_at: 1705407630
                    elapsed_time: 1.23
        '400':
          description: '`not_workflow_app` : 应用模式与 API 路由不匹配。'
          content:
            application/json:
              examples:
                not_workflow_app:
                  summary: not_workflow_app
                  value:
                    status: 400
                    code: not_workflow_app
                    message: Please check if your app mode matches the right API route.
        '404':
          description: '`not_found` : 未找到工作流运行记录。'
          content:
            application/json:
              examples:
                workflow_run_not_found:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Workflow run not found.
components:
  schemas:
    WorkflowRunDetailResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: 工作流运行 ID。
        workflow_id:
          type: string
          format: uuid
          description: 工作流 ID.
        status:
          type: string
          description: >-
            工作流执行状态。`running` 表示执行中，`succeeded` 表示成功完成，`failed` 表示执行出错，`stopped`
            表示手动停止，`partial-succeeded` 表示部分节点成功但其他失败，`paused` 表示等待人工介入。
        inputs:
          type: object
          additionalProperties: true
          description: 工作流运行的输入变量。
        outputs:
          type: object
          additionalProperties: true
          nullable: true
          description: 工作流的输出数据。
        error:
          type: string
          nullable: true
          description: 工作流失败时的错误消息。
        total_steps:
          type: integer
          description: 已执行的工作流总步数。
        total_tokens:
          type: integer
          description: 消耗的总令牌数。
        created_at:
          type: integer
          format: int64
          description: 工作流运行创建时的 Unix 时间戳。
        finished_at:
          type: integer
          format: int64
          nullable: true
          description: 工作流运行结束时的 Unix 时间戳。
        elapsed_time:
          type: number
          format: float
          nullable: true
          description: 总耗时（秒）。
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**

````