Images

GEThttps:/api.openai.com/v1/organization/usage/images

Get images usage details for the organization.

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
    string
    Defaults: 1d

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

  • sources
    array

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

  • sizes
    array

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

  • project_ids
    array
    Return only usage for these projects.
  • user_ids
    array
    Return only usage for these users.
  • api_key_ids
    array
    Return only usage for these API keys.
  • models
    array
    Return only usage for these models.
  • group_by
    array

    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.

  • 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

A list of paginated, time bucketed Images usage objects.

Example request
1
curl "https://api.openai.com/v1/organization/usage/images?start_time=1730419200&limit=1" \

2
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

3
-H "Content-Type: application/json"
Example response
1
{

2
    "object": "page",

3
    "data": [

4
        {

5
            "object": "bucket",

6
            "start_time": 1730419200,

7
            "end_time": 1730505600,

8
            "results": [

9
                {

10
                    "object": "organization.usage.images.result",

11
                    "images": 2,

12
                    "num_model_requests": 2,

13
                    "size": null,

14
                    "source": null,

15
                    "project_id": null,

16
                    "user_id": null,

17
                    "api_key_id": null,

18
                    "model": null

19
                }

20
            ]

21
        }

22
    ],

23
    "has_more": false,

24
    "next_page": null

25
}
Built with