Domain name for API request: vod.intl.tencentcloudapi.com.
This API returns AIGC statistical information within a specified time range.
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: 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. Enumeration values:
|
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| APIKey | No | String | API Key |
| APIKeys.N | No | Array of String | API Key |
| ScrollToken | No | String | Query cursor |
| PageSize | No | Integer | Size per page. Maximum value: 200. If it exceeds 200, it will be truncated to 200 |
| ReqId | No | String | RequestId for text generation. Valid when AigcType is TextDetail. |
| Parameter Name | Type | Description |
|---|---|---|
| AigcUsageDataSet | Array of AigcUsageDataItem | AIGC stats. |
| AigcTextDetails | AigcTextDetail | Text generation detailed log |
| 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: 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",
"APIKey": "xxxxxxxxxxxxx"
}{
"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"
}
}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. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
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