Skip to content
OpenBot

usage.listUsageEvents

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

Lists model calls, the newest first. Send next as after to get the next page.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
string
to
string
after
string
limit
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
occurredAt
required
string
source
required
string
Allowed values: turn compaction session_memory judge agent_memory other
sessionId
required
Any of:
string
turnId
required
Any of:
string
agentId
required
Any of:
string
userId
required
Any of:
string
tokenId
required
Any of:
string
provider
required
string
providerOwner
required
string
Allowed values: platform organization
model
required
string
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
priced
required
boolean
costMicros
required
integer
<= 9007199254740991
charged
required
boolean
next
required
Any of:
string

Example 

{
  "items": [
    {
      "source": "turn",
      "providerOwner": "platform"
    }
  ]
}

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"
}