Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create and enable AIGC quota configuration. Quota usage starts accumulating when the quota feature is enabled. Once the quota is reached, AIGC features will no longer be usable.
If the quota is deleted and re-enabled, the amount will be zero and recalculated.
Since content generation in AGC is an asynchronous task, real-time usage data cannot be obtained. Therefore, quota limits may result in some errors, and full precise control over the set limit cannot be achieved.
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: CreateAigcQuota. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | VOD application ID. From December 25, 2023, customers who activate on-demand services must fill in this field with the app ID when accessing resources in on-demand applications, whether in the default application or a newly created application. |
| QuotaType | Yes | String | Quota type Enumeration values:
|
| QuotaLimit | Yes | Integer | Number of quotas for the task. Unit: images/second/tokens.
|
| ApiToken | No | String | Valid only when QuotaType=Text, used to select the ApiToken that requires quota limit |
| QuotaPeriod | No | String | Quota reset cycle. Enumeration values:
|
| ResetDay | No | Integer | Reset date of the per month quota. Valid only when QuotaPeriod=Month. If the selected date does not exist in the current month, the reset is postponed to 00:00 on the 1st of the next month. |
| ModelQuotaSwitch | No | String | Whether to set specified quotas for each model Enumeration values:
|
| ModelQuotas.N | No | Array of AigcModelQuota | Quota set for each model, valid only when ModelQuotaSwitch=ON. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Set the image generation task quota to 1000 images.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcQuota
<Common request parameters>
{
"SubAppId": 200000004,
"QuotaType": "Image",
"QuotaLimit": 1000
}{
"Response": {
"RequestId": "6eccbd58-caee-4480-8048-90bff384404c"
}
}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.DBError | Operation failed: database operation failed. |
| InvalidParameterValue | Parameter value error. |
| ResourceNotFound.UserNotExist | The user does not exist. |
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