Search
K
OpenAI API

Get embeddings usage details for the organization.

get
https://api.openai.com/v1/organization/usage/embeddings

Query Parameters

start_timeintegerrequired

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

end_timeinteger

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

bucket_widthstring

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

Allowed values:1m1h1d

Default:1d

project_idsarray[string]

Return only usage for these projects.

user_idsarray[string]

Return only usage for these users.

api_key_idsarray[string]

Return only usage for these API keys.

modelsarray[string]

Return only usage for these models.

group_byarray[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.

Allowed values:project_iduser_idapi_key_idmodel

limitinteger

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
pagestring

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

Response

200 application/json

Usage data retrieved successfully.

UsageResponse

objectstringrequired

Allowed values:page

dataarray[object]required
Show Child Parameters
has_morebooleanrequired
next_pagestringrequired
get/organization/usage/embeddings
 
200 application/json

Get images usage details for the organization.

get
https://api.openai.com/v1/organization/usage/images

Query Parameters

start_timeintegerrequired

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

end_timeinteger

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

bucket_widthstring

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

Allowed values:1m1h1d

Default:1d

sourcesarray[string]

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

Allowed values:image.generationimage.editimage.variation

sizesarray[string]

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

Allowed values:256x256512x5121024x10241792x17921024x1792

project_idsarray[string]

Return only usage for these projects.

user_idsarray[string]

Return only usage for these users.

api_key_idsarray[string]

Return only usage for these API keys.

modelsarray[string]

Return only usage for these models.

group_byarray[string]

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.

Allowed values:project_iduser_idapi_key_idmodelsizesource

limitinteger

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
pagestring

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

Response

200 application/json

Usage data retrieved successfully.

UsageResponse

objectstringrequired

Allowed values:page

dataarray[object]required
Show Child Parameters
has_morebooleanrequired
next_pagestringrequired
get/organization/usage/images
 
200 application/json

Get moderations usage details for the organization.

get
https://api.openai.com/v1/organization/usage/moderations

Query Parameters

start_timeintegerrequired

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

end_timeinteger

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

bucket_widthstring

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

Allowed values:1m1h1d

Default:1d

project_idsarray[string]

Return only usage for these projects.

user_idsarray[string]

Return only usage for these users.

api_key_idsarray[string]

Return only usage for these API keys.

modelsarray[string]

Return only usage for these models.

group_byarray[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.

Allowed values:project_iduser_idapi_key_idmodel

limitinteger

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
pagestring

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

Response

200 application/json

Usage data retrieved successfully.

UsageResponse

objectstringrequired

Allowed values:page

dataarray[object]required
Show Child Parameters
has_morebooleanrequired
next_pagestringrequired
get/organization/usage/moderations
 
200 application/json

Get vector stores usage details for the organization.

get
https://api.openai.com/v1/organization/usage/vector_stores

Query Parameters

start_timeintegerrequired

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

end_timeinteger

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

bucket_widthstring

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

Allowed values:1m1h1d

Default:1d

project_idsarray[string]

Return only usage for these projects.

group_byarray[string]

Group the usage data by the specified fields. Support fields include project_id.

Allowed values:project_id

limitinteger

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
pagestring

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

Response

200 application/json

Usage data retrieved successfully.

UsageResponse

objectstringrequired

Allowed values:page

dataarray[object]required
Show Child Parameters
has_morebooleanrequired
next_pagestringrequired
get/organization/usage/vector_stores
 
200 application/json

Returns a list of invites in the organization.

get
https://api.openai.com/v1/organization/invites

Query Parameters

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Default:20

afterstring

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Response

200 application/json

Invites listed successfully.

InviteListResponse

objectstringrequired

The object type, which is always list

Allowed values:list

dataarray[object]required

Represents an individual invite to the organization.

Show Child Parameters
first_idstring

The first invite_id in the retrieved list

last_idstring

The last invite_id in the retrieved list

has_moreboolean

The has_more property is used for pagination to indicate there are additional results.

get/organization/invites
 
200 application/json