帮你快速理解、总结文档立即下载
文档中心>腾讯云智能体开发平台>API 文档>工作流相关接口>创建工作流运行实例

创建工作流运行实例

最近更新时间：2026-10-12 10:41:15
我的收藏

本页目录：

1. 接口描述

接口请求域名： adp.tencentcloudapi.com 。

本接口用来创建工作流的异步运行实例，创建成功后工作流会在后台异步运行，接口返回工作流运行实例ID（WorkflowRunId）等信息。后面可通过调用DescribeWorkflowRun接口查工作流运行的详情。
注意：工作流的异步运行是基于应用的，需要先把对应的应用配置成“单工作流模式”，才能创建成功。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateWorkflowRun。
Version 是 String 公共参数，本接口取值：2026-05-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
AppId 是 String

应用ID, 获取方法参看如何获取 AppId


示例值：1854548189164339200
Domain 是 Integer

运行环境。1:开发域，2:生产域


示例值：1
Query 否 String

用户输入的内容


示例值：我想订明天的酒店
CustomVariableList.N 否 Array of CustomVariable

API参数配置
UserId 否 String

用户ID


示例值：user-123

3. 输出参数

参数名称 类型 描述
WorkflowRunId String

工作流运行实例的ID


示例值：8ad82e0553507b4c1ba771fb53029492
CreateTime String

创建时间（毫秒时间戳）


示例值：1744707612000
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建工作流运行实例

创建工作流运行实例

输入示例

POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkflowRun
<公共请求参数>

{
    "AppId": "2075134221221714816",
    "Domain": 1,
    "Query": "我想买车"
}

输出示例

{
    "Response": {
        "CreateTime": "1784010161430",
        "WorkflowRunId": "wfr-cdcp9hyus1ds",
        "RequestId": "9c2def7a-ebdd-45cd-ada5-2898de26bd1d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
MissingParameter 缺少参数错误。
中国站