Domain name for API request: adp.intl.tencentcloudapi.com.
This API is used to create an asynchronous running instance of a workflow. After successful creation, the workflow runs asynchronously in the backend. The API returns the workflow running instance ID (WorkflowRunId) and other information. You can call the DescribeWorkflowRun API to query the workflow running details.
Note: Asynchronous execution of a workflow is application-based. The corresponding application configuration must be set to "Single Workflow Mode" before it can be successfully created.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateWorkflowRun. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AppId | Yes | String | Application ID. For how to obtain it, see AppId |
| Domain | Yes | Integer | Execution environment. 1: Development domain, 2: Production domain |
| Query | No | String | User input. |
| CustomVariableList.N | No | Array of CustomVariable | API parameter configuration |
| UserId | No | String | uid |
| Parameter Name | Type | Description |
|---|---|---|
| WorkflowRunId | String | ID of the workflow running instance |
| CreateTime | String | Creation time (timestamp in milliseconds) |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create a workflow running instance
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkflowRun
<Common request parameters>
{
"AppId": "2075134221221714816",
"Domain": 1,
"Query": "I want to buy a car"
}{
"Response": {
"CreateTime": "1784010161430",
"WorkflowRunId": "wfr-cdcp9hyus1ds",
"RequestId": "9c2def7a-ebdd-45cd-ada5-2898de26bd1d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| MissingParameter | Parameters are missing. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback