## Images

`admin.organization.usage.images(**kwargs) -> UsageImagesResponse`

**get** `/organization/usage/images`

Get images usage details for the organization.

### Parameters

- `start_time: Integer`

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

- `api_key_ids: Array[String]`

  Return only usage for these API keys.

- `bucket_width: :"1m" | :"1h" | :"1d"`

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

  - `:"1m"`

  - `:"1h"`

  - `:"1d"`

- `end_time: Integer`

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

- `group_by: Array[:project_id | :user_id | :api_key_id | 3 more]`

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

  - `:project_id`

  - `:user_id`

  - `:api_key_id`

  - `:model`

  - `:size`

  - `:source`

- `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

- `models: Array[String]`

  Return only usage for these models.

- `page: String`

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

- `project_ids: Array[String]`

  Return only usage for these projects.

- `sizes: Array[:"256x256" | :"512x512" | :"1024x1024" | 2 more]`

  Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them.

  - `:"256x256"`

  - `:"512x512"`

  - `:"1024x1024"`

  - `:"1792x1792"`

  - `:"1024x1792"`

- `sources: Array[:"image.generation" | :"image.edit" | :"image.variation"]`

  Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them.

  - `:"image.generation"`

  - `:"image.edit"`

  - `:"image.variation"`

- `user_ids: Array[String]`

  Return only usage for these users.

### Returns

- `class UsageImagesResponse`

  - `data: Array[Data{ end_time, object, results, start_time}]`

    - `end_time: Integer`

    - `object: :bucket`

      - `:bucket`

    - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 21 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

      - `class OrganizationUsageCompletionsResult`

        The aggregated completions usage details of the specific time bucket.

        - `input_tokens: Integer`

          The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.completions.result"`

          - `:"organization.usage.completions.result"`

        - `output_tokens: Integer`

          The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

        - `api_key_id: String`

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

        - `api_source: :agents_api | :unlabeled`

          When grouped by `api_source`, `agents_api` identifies attributed Agents API activity and `unlabeled` includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.

          - `:agents_api`

          - `:unlabeled`

        - `batch: bool`

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

        - `input_audio_tokens: Integer`

          The aggregated number of uncached audio input tokens used.

        - `input_cache_write_12h_tokens: Integer`

          The aggregated number of input tokens written to the cache with a 12-hour retention period.

        - `input_cache_write_tokens: Integer`

          The aggregated number of input tokens written to the cache with a 30-minute retention period.

        - `input_cached_audio_tokens: Integer`

          The aggregated number of cached audio input tokens used.

        - `input_cached_image_tokens: Integer`

          The aggregated number of cached image input tokens used.

        - `input_cached_text_tokens: Integer`

          The aggregated number of cached text input tokens used.

        - `input_cached_tokens: Integer`

          The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

        - `input_image_tokens: Integer`

          The aggregated number of uncached image input tokens used.

        - `input_text_tokens: Integer`

          The aggregated number of uncached text input tokens used, excluding cache-write tokens.

        - `input_uncached_tokens: Integer`

          The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

        - `model: String`

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

        - `output_audio_tokens: Integer`

          The aggregated number of audio output tokens used.

        - `output_image_tokens: Integer`

          The aggregated number of image output tokens used.

        - `output_text_tokens: Integer`

          The aggregated number of text output tokens used.

        - `project_id: String`

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

        - `service_tier: String`

          When `group_by=service_tier`, this field provides the service tier of the grouped usage result.

        - `user_id: String`

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

      - `class OrganizationUsageEmbeddingsResult`

        The aggregated embeddings usage details of the specific time bucket.

        - `input_tokens: Integer`

          The aggregated number of input tokens used.

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.embeddings.result"`

          - `:"organization.usage.embeddings.result"`

        - `api_key_id: String`

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

        - `model: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

      - `class OrganizationUsageModerationsResult`

        The aggregated moderations usage details of the specific time bucket.

        - `input_tokens: Integer`

          The aggregated number of input tokens used.

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.moderations.result"`

          - `:"organization.usage.moderations.result"`

        - `api_key_id: String`

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

        - `model: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

      - `class OrganizationUsageImagesResult`

        The aggregated images usage details of the specific time bucket.

        - `images: Integer`

          The number of images processed.

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.images.result"`

          - `:"organization.usage.images.result"`

        - `api_key_id: String`

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

        - `model: String`

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

        - `project_id: String`

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

        - `size: String`

          When `group_by=size`, this field provides the image size of the grouped usage result.

        - `source: String`

          When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`.

        - `user_id: String`

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

      - `class OrganizationUsageAudioSpeechesResult`

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

        - `characters: Integer`

          The number of characters processed.

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.audio_speeches.result"`

          - `:"organization.usage.audio_speeches.result"`

        - `api_key_id: String`

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

        - `model: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

      - `class OrganizationUsageAudioTranscriptionsResult`

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

        - `num_model_requests: Integer`

          The count of requests made to the model.

        - `object: :"organization.usage.audio_transcriptions.result"`

          - `:"organization.usage.audio_transcriptions.result"`

        - `seconds: Integer`

          The number of seconds processed.

        - `api_key_id: String`

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

        - `model: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

      - `class OrganizationUsageVectorStoresResult`

        The aggregated vector stores usage details of the specific time bucket.

        - `object: :"organization.usage.vector_stores.result"`

          - `:"organization.usage.vector_stores.result"`

        - `usage_bytes: Integer`

          The vector stores usage in bytes.

        - `project_id: String`

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

      - `class OrganizationUsageCodeInterpreterSessionsResult`

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

        - `num_sessions: Integer`

          The number of code interpreter sessions.

        - `object: :"organization.usage.code_interpreter_sessions.result"`

          - `:"organization.usage.code_interpreter_sessions.result"`

        - `project_id: String`

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

      - `class OrganizationUsageFileSearchesResult`

        The aggregated file search calls usage details of the specific time bucket.

        - `num_requests: Integer`

          The count of file search calls.

        - `object: :"organization.usage.file_searches.result"`

          - `:"organization.usage.file_searches.result"`

        - `api_key_id: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

        - `vector_store_id: String`

          When `group_by=vector_store_id`, this field provides the vector store ID of the grouped usage result.

      - `class OrganizationUsageWebSearchesResult`

        The aggregated web search calls usage details of the specific time bucket.

        - `num_model_requests: Integer`

          The count of model requests.

        - `num_requests: Integer`

          The count of web search calls.

        - `object: :"organization.usage.web_searches.result"`

          - `:"organization.usage.web_searches.result"`

        - `api_key_id: String`

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

        - `api_source: :agents_api | :unlabeled`

          When grouped by `api_source`, `agents_api` identifies attributed Agents API activity and `unlabeled` includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.

          - `:agents_api`

          - `:unlabeled`

        - `context_level: String`

          When `group_by=context_level`, this field provides the search context size of the grouped usage result.

        - `model: String`

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

        - `project_id: String`

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

        - `user_id: String`

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

      - `class OrganizationCostsResult`

        The aggregated costs details of the specific time bucket.

        - `object: :"organization.costs.result"`

          - `:"organization.costs.result"`

        - `amount: Amount{ currency, value}`

          The monetary value in its associated currency.

          - `currency: String`

            Lowercase ISO-4217 currency e.g. "usd"

          - `value: Float`

            The numeric value of the cost.

        - `api_key_id: String`

          When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.

        - `api_source: :agents_api | :unlabeled`

          When grouped by `api_source`, `agents_api` identifies attributed Agents API activity and `unlabeled` includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.

          - `:agents_api`

          - `:unlabeled`

        - `line_item: String`

          When `group_by=line_item`, this field provides the line item of the grouped costs result.

        - `project_id: String`

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

        - `quantity: Float`

          When `group_by=line_item`, this field provides the quantity of the grouped costs result.

        - `quantity_unit: CostQuantityUnit`

          The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.

          - `String = String`

          - `CostQuantityUnit = :tokens | :"1000_tokens" | :duration_seconds | 5 more`

            The unit of the `quantity` value. If no single supported unit applies to the result, this field is `null`.

            - `:tokens`

            - `:"1000_tokens"`

            - `:duration_seconds`

            - `:duration_minutes`

            - `:duration_hours`

            - `:gibibyte_hours`

            - `:images`

            - `:characters`

        - `user_id: String`

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

    - `start_time: Integer`

  - `has_more: bool`

  - `next_page: String`

  - `object: :page`

    - `:page`

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

response = openai.admin.organization.usage.images(start_time: 0)

puts(response)
```

#### Response

```json
{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "api_source": "agents_api",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cache_write_12h_tokens": 0,
          "input_cache_write_tokens": 0,
          "input_cached_audio_tokens": 0,
          "input_cached_image_tokens": 0,
          "input_cached_text_tokens": 0,
          "input_cached_tokens": 0,
          "input_image_tokens": 0,
          "input_text_tokens": 0,
          "input_uncached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "output_image_tokens": 0,
          "output_text_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}
```