DescribeTokenUsage

Last updated: 2025-10-30 21:49:01

DescribeTokenUsage

Last updated: 2025-10-30 21:49:01

1. API Description

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.

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: 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. This API only supports: ap-jakarta.
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.
StartTime	No	String	Start timestamp, in seconds (default value: 0).
EndTime	No	String	End timestamp, in seconds (default value: 0, must be greater than the start timestamp).
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
SpaceId	No	String

3. Output Parameters

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.

4. Example

Example1 Get Call Statistics

Get call statistics.

Input Example

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

{
    "UinAccount": [
        "700001187441"
    ]
}

Output Example

{
    "Response": {
        "ApiCallStats": 10,
        "InputTokenUsage": 1120,
        "OutputTokenUsage": 101,
        "RequestId": "716109cc-ee93-423a-85f0-a21fb7afcc4f",
        "SearchUsage": 10,
        "TotalTokenUsage": 1221
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

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

Yes

Feedback

tencent cloud