Skip to main content
GET
Get organization usage

Authorizations

Authorization
string
header
required

A management key (created from the organization dashboard or with POST /v3/manage/auth-keys), sent as Authorization: Bearer <management_key>. Inference API keys (sk-eden...) are not accepted on these endpoints.

Query Parameters

begin
string<date>

First day of the window (inclusive). Provide both begin and end, or neither to get the last 7 days.

end
string<date>

Day after the last day of the window (exclusive). The window may not exceed 366 days.

feature
string

Only count this feature.

Minimum string length: 1
group_by
enum<string>

Break the totals down per member.

  • user - user
Available options:
user
Minimum string length: 1
key_id
string<uuid>

Only count usage of this API key (404 if not in the organization).

phase
string

Only count this phase.

Minimum string length: 1
provider
string

Only count this provider.

Minimum string length: 1
step
integer
required

Granularity of the time series: 1 = day, 2 = week, 3 = month, 4 = year.

Required range: 1 <= x <= 4
subfeature
string

Only count this subfeature.

Minimum string length: 1
token
string

Only count usage of the API keys with this name. Use base_token for usage not attributed to any key. Ignored when key_id is given.

Minimum string length: 1
user
string<email>

Only count usage of this member (404 if not in the organization).

Minimum string length: 1

Response

200 - application/json

Organization usage: a time series per API key, or one total per member when group_by=user is set.

usage
TokenData · object
required