Audio speeches

Get audio speeches usage details for the organization.

GET /organization/usage/audio_speeches

Try it

Audio speeches

cURL

curl --request GET \
  --url https://api.openai.com/v1/organization/usage/audio_speeches \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "page",
  "data": [
    {
      "object": "bucket",
      "start_time": 123,
      "end_time": 123,
      "result": [
        {
          "object": "organization.usage.completions.result",
          "input_tokens": 123,
          "output_tokens": 123,
          "num_model_requests": 123,
          "input_cached_tokens": 123,
          "input_audio_tokens": 123,
          "output_audio_tokens": 123,
          "project_id": "<string>",
          "user_id": "<string>",
          "api_key_id": "<string>",
          "model": "<string>",
          "batch": true
        }
      ]
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_time · integer · required

Start time (Unix seconds) of the query time range, inclusive.

end_time · integer

End time (Unix seconds) of the query time range, exclusive.

bucket_width · enum<string> · default: 1d

Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

Available options: 1m, 1h, 1d

project_ids · string[]

Return only usage for these projects.

user_ids · string[]

Return only usage for these users.

api_key_ids · string[]

Return only usage for these API keys.

models · string[]

Return only usage for these models.

group_by · enum<string>[]

Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

Available options: project_id, user_id, api_key_id, model

limit · integer

Specifies the number of buckets to return.

• bucket_width=1d: default: 7, max: 31
• bucket_width=1h: default: 24, max: 168
• bucket_width=1m: default: 60, max: 1440

page · string

A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Response

200 - application/json

Usage data retrieved successfully.

object · enum<string> · required

Available options: page

data · object[] · required

Show child attributes

data. object · enum<string> · required

Available options: bucket

data. start_time · integer · required

data. end_time · integer · required

data. result · object[] · required

The aggregated completions usage details of the specific time bucket.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Show child attributes

data.result. object · enum<string> · required

Available options: organization.usage.completions.result

data.result. input_tokens · integer · required

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

data.result. output_tokens · integer · required

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

data.result. num_model_requests · integer · required

The count of requests made to the model.

data.result. input_cached_tokens · integer

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.

data.result. input_audio_tokens · integer

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

data.result. output_audio_tokens · integer

The aggregated number of audio output tokens used.

data.result. project_id · string | null

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

data.result. user_id · string | null

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

data.result. api_key_id · string | null

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

data.result. model · string | null

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

data.result. batch · boolean | null

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

has_more · boolean · required

next_page · string · required