API Reference

Admin

Organization

Usage

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Images

UsageImagesResponse admin().organization().usage().images(UsageImagesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/organization/usage/images

Get images usage details for the organization.

ParametersExpand Collapse

UsageImagesParams params

long startTime

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

Optional<List<String>> apiKeyIds

Return only usage for these API keys.

Optional<BucketWidth> bucketWidth

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

Optional<Long> endTime

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

Optional<List<GroupBy>> groupBy

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.

Optional<Long> limit

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

Optional<List<String>> models

Return only usage for these models.

Optional<String> page

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

Optional<List<String>> projectIds

Return only usage for these projects.

Optional<List<Size>> sizes

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

Optional<List<Source>> sources

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

Optional<List<String>> userIds

Return only usage for these users.

ReturnsExpand Collapse

class UsageImagesResponse:

List<Data> data

boolean hasMore

Optional<String> nextPage

JsonValue; object_ "page"constant"page"constant

Images

Java

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.usage.UsageImagesParams;
import com.openai.models.admin.organization.usage.UsageImagesResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        UsageImagesParams params = UsageImagesParams.builder()
            .startTime(0L)
            .build();
        UsageImagesResponse response = client.admin().organization().usage().images(params);
    }
}

{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.images.result",
                    "images": 2,
                    "num_model_requests": 2,
                    "size": null,
                    "source": null,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}

Returns Examples

{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.images.result",
                    "images": 2,
                    "num_model_requests": 2,
                    "size": null,
                    "source": null,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "model": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}