Domain name for API request: lke.intl.tencentcloudapi.com.
This API is used to query API call token details.
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: DescribeTokenUsage. |
| Version | Yes | String | Common Params. The value used for this API: 2023-11-30. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| UinAccount.N | No | Array of String | Root account of Tencent Cloud. |
| LoginUin | No | String | Log in to user's root account (required in the integrator mode). |
| LoginSubAccountUin | No | String | Login to user's sub-account (required in integrator mode). |
| SubBizType | No | String | Sub-business types of Tencent Cloud Agent Development Platform/ADP: FileParse (document parsing), embedding, Rewrite (multi-round rewriting), Concurrency, KnowledgeSummary (knowledge summary), KnowledgeQA (knowledge Q&A), KnowledgeCapacity (knowledge base capacity), SearchEngine (search engine). |
| ModelName | No | String | Model identifier. |
| AppBizIds.N | No | Array of String | Application ID list. |
| SubScenes.N | No | Array of String | Filter sub-scenario (used in document parsing scenario). |
| AppType | No | String | Application Type (knowledge_qa: Knowledge Q&A Application Management, shared_knowledge: Shared Knowledge Base) |
| SpaceId | No | String | Space ID, used to limit the query scope. If left blank, data of all spaces will be returned. |
| StatStartTime | No | Integer | Start time. Unix timestamp in seconds, empty by default. |
| StatEndTime | No | Integer | End time. Unix timestamp in seconds, empty by default. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalTokenUsage | Float | Total token consumption. |
| InputTokenUsage | Float | Input token consumption. |
| OutputTokenUsage | Float | Output token consumption. |
| ApiCallStats | Integer | Number of API calls. |
| SearchUsage | Float | Number of search service calls. |
| PageUsage | Integer | Number of pages consumed by document parsing. |
| SplitTokenUsage | Float | Token consumption by splitting. |
| RagSearchUsage | Float | Number of Rag retrievals. |
| InternetSearchUsage | Float | Number of online searches. |
| DosageTypeLimit | Float | |
| DosageTypeCurr | Float | |
| 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: lke.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenUsage
<Common Request Parameter>
{
"ModelName": "cs-normal-70b",
"StartTime": "1758988800",
"EndTime": "1759075199",
"UinAccount": [],
"AppBizIds": [],
"SubScenes": [],
"AppType": "knowledge_qa",
"SpaceId": "default_space",
"StatStartTime": 1758988800,
"StatEndTime": 1759075199
}
{
"Response": {
"ApiCallStats": 4909,
"DosageTypeCurr": 0,
"DosageTypeLimit": 0,
"InputTokenUsage": 3178475,
"InternetSearchUsage": 0,
"OutputTokenUsage": 439374,
"PageUsage": 0,
"RagSearchUsage": 0,
"RequestId": "a35fa69b-118b-4b25-8f1d-e5478f2b7159",
"SearchUsage": 0,
"SplitTokenUsage": 0,
"TotalTokenUsage": 3617849
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
피드백