Domain name for API request: monitor.intl.tencentcloudapi.com.
Create a task
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: CreateAIWorkbenchTask. |
| Version | Yes | String | Common Params. The value used for this API: 2023-06-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Name | No | String | Task Name |
| Description | No | String | Task description |
| AgentId | No | String | Associated Agent ID |
| PromptTemplate | No | String | Prompt Template |
| OutputFormat | No | String | Output format: markdown / json |
| TriggerType | No | String | Trigger type: manual / cron / webhook |
| CronExpr | No | String | Cron expression |
| CronTimezone | No | String | Cron time zone |
| ResourceMapId | No | String | Associated resource map ID |
| SkillIds.N | No | Array of String | Skill ID list |
| McpEndpointIds.N | No | Array of String | MCP endpoint ID list |
| TimeoutSec | No | Integer | Timeout (seconds) |
| RetryCount | No | Integer | Retry count |
| Enabled | No | Boolean | Whether to enable |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| 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. |
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIWorkbenchTask
<Common request parameters>
{
"Name": "Test Task",
"Description": "For testing task creation",
"AgentId": "agt-********",
"TriggerType": "cron",
"ResourceMapId": "coll-********",
"SkillIds": [
"skl-********"
],
"TimeoutSec": 61,
"RetryCount": 4,
"Enabled": true,
"McpEndpointIds": [
"mcp-********"
]
}{
"Response": {
"TaskId": "tsk-********",
"RequestId": "ea9b8eba-07bf-4384-a2db-6e316b6bcb2e"
}
}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. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック