Skip to content
OpenBot

usage.getUsage

GET
/v1/organization/usage
curl --request GET \
  --url 'https://example.com/v1/organization/usage?groupBy=day' \
  --header 'Authorization: Bearer <token>'

Adds up the tokens and the cost of the model calls in a time range. groupBy is day when you leave it out.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
string
to
string
groupBy
string
Allowed values: day model provider member agent token source

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
from
required
string
to
required
string
groupBy
required
string
Allowed values: day model provider member agent token source
total
required
object
calls
required
integer
>= -9007199254740991 <= 9007199254740991
inputUncached
required
integer
>= -9007199254740991 <= 9007199254740991
inputCacheRead
required
integer
>= -9007199254740991 <= 9007199254740991
inputCacheWrite
required
integer
>= -9007199254740991 <= 9007199254740991
outputText
required
integer
>= -9007199254740991 <= 9007199254740991
outputReasoning
required
integer
>= -9007199254740991 <= 9007199254740991
costMicros
required
integer
<= 9007199254740991
items
required
Array<object>
object
key
required
Any of:
string
calls
required
integer
>= -9007199254740991 <= 9007199254740991
inputUncached
required
integer
>= -9007199254740991 <= 9007199254740991
inputCacheRead
required
integer
>= -9007199254740991 <= 9007199254740991
inputCacheWrite
required
integer
>= -9007199254740991 <= 9007199254740991
outputText
required
integer
>= -9007199254740991 <= 9007199254740991
outputReasoning
required
integer
>= -9007199254740991 <= 9007199254740991
costMicros
required
integer
<= 9007199254740991

Example 

{
  "groupBy": "day"
}

400

Section titled “400”

UsageQueryInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: UsageQueryInvalid
message
required
string

Example 

{
  "_tag": "UsageQueryInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | BillingUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}