tencent cloud

媒体处理

DescribeAigcTaskList

Download
聚焦模式
字号
最后更新时间: 2026-08-12 19:13:46

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

Query AIGC task list details

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeAigcTaskList.
Version Yes String Common Params. The value used for this API: 2019-06-12.
Region No String Common Params. This parameter is not required for this API.
PageNum No Integer

Query page started

PageSize No Integer

How many data to get on the current page

QueryTaskFilter No QueryTaskFilter

Query filter criteria

3. Output Parameters

Parameter Name Type Description
Total Integer

Total return count of the current task

PageNum Integer

Query page started

PageSize Integer

Number of data entries to retrieve on the current page

Tasks Array of AigcTaskListItem

Task detail data

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.

4. Example

Example1 Query Task List API - Filter by Task ID

Filter by task ID

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAigcTaskList
<Common request parameters>

{
    "QueryTaskFilter": {
        "TaskId": "5ddc84c0-fe47-4cc8-35b8-ae8c313d1b9e"
    }
}

Output Example

{
    "Response": {
        "PageNum": 1,
        "PageSize": 10,
        "Tasks": [
            {
                "CreateTime": "2026-05-26 20:19:49",
                "FinishedTime": "2026-05-26 20:27:08",
                "RequestBody": "\"{\\\"Input\\\":{\\\"Url\\\":\\\"https://lewis-1302487817.cos.ap-guangzhou.myqcloud.com/replace-test/1s.mp4\\\"},\\\"Action\\\":\\\"CreateVideoRedrawTask\\\",\\\"RequestId\\\":\\\"3a35e21a-f31a-4a49-983f-0b7fc4ab5214\\\",\\\"Uin\\\":\\\"600000563781\\\",\\\"ApiModule\\\":\\\"mps\\\",\\\"Region\\\":\\\"\\\",\\\"AppId\\\":1300057355}\"",
                "ScheduledTime": "2026-05-26 20:19:50",
                "TaskId": "5ddc84c0-fe47-4cc8-35b8-ae8c313d1b9e",
                "TaskStatus": "FINISHED",
                "TaskType": "RedrawVideo",
                "Urls": [
                    "https://aigc-redraw-output-1311402212.cos.ap-guangzhou.myqcloud.com/5ddc84c0-fe47-4cc8-35b8-ae8c313d1b9e/redraw_output.mp4?q-sign-algorithm=sha1&q-ak=*************JTUcikdRfpuskSUVd4PZbgd&q-sign-time=1779798367%3B1780403227&q-key-time=1779798367%3B1780403227&q-header-list=host&q-url-param-list=&q-signature=51d24ba6906aa4ff9df4103169e3606d4bc650ef"
                ]
            }
        ],
        "Total": 1,
        "RequestId": "748b8335-f8b3-4eaf-aa67-bc284c4dc45a"
    }
}

Example2 Query Task List API - Filter by Task Type

Filter by task type

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAigcTaskList
<Common request parameters>

{
    "QueryTaskFilter": {
        "TaskType": "VideoRedraw"
    }
}

Output Example

{
    "Response": {
        "PageNum": 1,
        "PageSize": 10,
        "Tasks": [
            {
                "CreateTime": "2026-05-26 20:19:49",
                "FinishedTime": "2026-05-26 20:27:08",
                "RequestBody": "\"{\\\"Input\\\":{\\\"Url\\\":\\\"https://lewis-1302487817.cos.ap-guangzhou.myqcloud.com/replace-test/1s.mp4\\\"},\\\"Action\\\":\\\"CreateVideoRedrawTask\\\",\\\"RequestId\\\":\\\"3a35e21a-f31a-4a49-983f-0b7fc4ab5214\\\",\\\"Uin\\\":\\\"600000563781\\\",\\\"ApiModule\\\":\\\"mps\\\",\\\"Region\\\":\\\"\\\",\\\"AppId\\\":1300057355}\"",
                "ScheduledTime": "2026-05-26 20:19:50",
                "TaskId": "5ddc84c0-fe47-4cc8-35b8-ae8c313d1b9e",
                "TaskStatus": "FINISHED",
                "TaskType": "RedrawVideo",
                "Urls": [
                    "https://aigc-redraw-output-1311402212.cos.ap-guangzhou.myqcloud.com/5ddc84c0-fe47-4cc8-35b8-ae8c313d1b9e/redraw_output.mp4?q-sign-algorithm=****&q-ak=************************skSUVd4PZbgd&q-sign-time=1779798367%3B1780403227&q-key-time=1779798367%3B1780403227&q-header-list=host&q-url-param-list=&q-signature=51d24ba6906aa4ff9df4103169e3606d4bc650ef"
                ]
            }
        ],
        "Total": 22,
        "RequestId": "3328c124-d304-42d2-b926-01adae1c10ee"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.QueryAIGCTaskFailed Error occurred while querying the task
ResourceNotFound.TaskNotFound The task does not exist

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈