Method: models.countTextTokens

Runs a model's tokenizer on a text and returns the token count.

HTTP request

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTextTokens

Path parameters

Parameters
model

string

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 models.list method.

Format: models/{model}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "prompt": {
    object (TextPrompt)
  }
}
Fields
prompt

object (TextPrompt)

Required. The free-form input text given to the model as a prompt.

Response body

A response from models.countTextTokens.

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

integer

The number of tokens that the model tokenizes the prompt into.

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.