OpenAI API

UsageAudioSpeechesResult

object

The aggregated audio speeches usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.audio_speeches.result

charactersintegerrequired

The number of characters processed.

num_model_requestsintegerrequired

The count of requests made to the model.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

user_idstring

When group_by=user_id, this field provides the user ID of the grouped usage result.

api_key_idstring

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

modelstring

When group_by=model, this field provides the model name of the grouped usage result.

Example

UsageAudioTranscriptionsResult

object

The aggregated audio transcriptions usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.audio_transcriptions.result

secondsintegerrequired

The number of seconds processed.

num_model_requestsintegerrequired

The count of requests made to the model.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

user_idstring

When group_by=user_id, this field provides the user ID of the grouped usage result.

api_key_idstring

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

modelstring

When group_by=model, this field provides the model name of the grouped usage result.

Example

UsageCodeInterpreterSessionsResult

object

The aggregated code interpreter sessions usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.code_interpreter_sessions.result

num_sessionsinteger

The number of code interpreter sessions.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

Example

UsageCompletionsResult

object

The aggregated completions usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.completions.result

input_tokensintegerrequired

The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

input_cached_tokensinteger

The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

output_tokensintegerrequired

The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

input_audio_tokensinteger

The aggregated number of audio input tokens used, including cached tokens.

output_audio_tokensinteger

The aggregated number of audio output tokens used.

num_model_requestsintegerrequired

The count of requests made to the model.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

user_idstring

When group_by=user_id, this field provides the user ID of the grouped usage result.

api_key_idstring

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

modelstring

When group_by=model, this field provides the model name of the grouped usage result.

batchboolean

When group_by=batch, this field tells whether the grouped usage result is batch or not.

Example

UsageEmbeddingsResult

object

The aggregated embeddings usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.embeddings.result

input_tokensintegerrequired

The aggregated number of input tokens used.

num_model_requestsintegerrequired

The count of requests made to the model.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

user_idstring

When group_by=user_id, this field provides the user ID of the grouped usage result.

api_key_idstring

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

modelstring

When group_by=model, this field provides the model name of the grouped usage result.

Example