Retrieves the cumulative AI token usage for a specified session.
Operation description
Description
This operation retrieves usage statistics for AI tokens in a specified session. It provides a breakdown of tokens for prompts, completions, and thoughts, as well as the total token count and the number of cache-hit tokens.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Jsonrpc |
string |
No |
The JSON-RPC version. The value is always 2.0. |
2.0 |
| Id |
string |
No |
The ID provided by the requester, which is echoed in the response. |
1033814166 |
| Params |
object |
No |
Business parameters. |
|
| SessionId |
string |
No |
The session ID. Required. |
sess_0f12abc34 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The ID of the request. |
B313938A-4475-599B-98EB-A0875019FD5B |
| JsonRpcResponse |
object |
The JSON-RPC result. |
|
| Jsonrpc |
string |
The JSON-RPC version. The value is always 2.0. |
2.0 |
| Id |
string |
The ID provided by the requester, which is echoed in the response. |
8212598228302533855 |
| Result |
object |
Token usage result. |
|
| PromptTokens |
integer |
Cumulative number of prompt tokens consumed. |
1000 |
| CompletionTokens |
integer |
Cumulative number of completion tokens generated. |
2000 |
| ThoughtsTokens |
integer |
Cumulative number of tokens used for thoughts. |
3000 |
| TotalTokens |
integer |
The cumulative number of all tokens. |
2000 |
| CachedTokens |
integer |
The cumulative number of cache-hit tokens. |
4000 |
Examples
Success response
JSON format
{
"RequestId": "B313938A-4475-599B-98EB-A0875019FD5B",
"JsonRpcResponse": {
"Jsonrpc": "2.0",
"Id": "8212598228302533855",
"Result": {
"PromptTokens": 1000,
"CompletionTokens": 2000,
"ThoughtsTokens": 3000,
"TotalTokens": 2000,
"CachedTokens": 4000
}
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.