DescribeAigcUsageData

Last updated:2026-03-20 09:46:29

DescribeAigcUsageData

Last updated: 2026-03-20 09:46:29

1. API Description

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

This API is used to return statistical information of AIGC within a specified time range.

AIGC stats from the last 365 days can be queried.
1. The query time span should not exceed 90 days.
If the query time span exceeds 1 day, return data with day-level granularity. Otherwise, return data with 5-minute granularity.

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: DescribeAigcUsageData.
Version	Yes	String	Common Params. The value used for this API: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
StartTime	Yes	String	Start date. Use the ISO date format.
EndTime	Yes	String	End date, which must be greater than or equal to the start date. Use the ISO date format.
AigcType	Yes	String	AIGC type. Valid values: Video: video. Image: image. Text: text.
SubAppId	No	Integer	On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether the default application or a newly created application).

3. Output Parameters

Parameter Name	Type	Description
AigcUsageDataSet	Array of AigcUsageDataItem	AIGC stats.
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 AI-generated video usage data

Input Example

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

{
    "StartTime": "2025-11-18T00:00:00+08:00",
    "EndTime": "2025-11-19T23:59:00+08:00",
    "AigcType": "Video"
}

Output Example

{
    "Response": {
        "AigcUsageDataSet": [
            {
                "DataSet": [
                    {
                        "Count": 0,
                        "Time": "2025-11-17T00:00:00+08:00",
                        "Usage": 0
                    },
                    {
                        "Count": 3,
                        "Time": "2025-11-18T00:00:00+08:00",
                        "Usage": 15
                    },
                    {
                        "Count": 0,
                        "Time": "2025-11-19T00:00:00+08:00",
                        "Usage": 0
                    }
                ],
                "Specification": "Kling2.0&2.1std_720P"
            }
        ],
        "RequestId": "2f47fc6d-c03a-49f7-b50b-xxxxxxxx"
    }
}

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

Tencent Cloud CLI 3.0

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	Operation failed.
FailedOperation.InvalidVodUser	The VOD service is not activated.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud