Runs a model's tokenizer on a string and returns the token count.
HTTP request
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countMessageTokens
Path parameters
Parameters | |
---|---|
model |
Required. The model's resource name. This serves as an ID for the Model to use. This name should match a model name returned by the Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"prompt": {
object ( |
Fields | |
---|---|
prompt |
Required. The prompt, whose token count is to be returned. |
Response body
A response from models.countMessageTokens
.
It returns the model's tokenCount
for the prompt
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "tokenCount": integer } |
Fields | |
---|---|
tokenCount |
The number of tokens that the Always non-negative. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/generative-language
https://www.googleapis.com/auth/generative-language.tuning
https://www.googleapis.com/auth/generative-language.tuning.readonly
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
For more information, see the Authentication Overview.