usage.listUsageEvents

GET

/v1/organization/usage/events

const url = 'https://example.com/v1/organization/usage/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

token
session

Parameters

Query Parameters

from

string

after

string

limit

string

Responses

200

Success

application/json

object

items

required

Array<object>

object

required

string

>= 1 characters <= 128 characters

executionId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

status

required

string

Allowed values: pending confirmed unknown

startedAt

required

string

reservedMicros

required

integer

<= 9007199254740991

estimatedMicros

required

Any of:

integer
null

integer

<= 9007199254740991

estimatedTokens

required

integer

<= 9007199254740991

occurredAt

required

string

source

required

string

Allowed values: turn compaction judge bot_memory other

chatId

required

Any of:

string
null

string

turnId

required

Any of:

string
null

string

botId

required

Any of:

string
null

string

userId

required

Any of:

string
null

string

tokenId

required

Any of:

string
null

string

>= 1 characters <= 128 characters

provider

required

string

providerOwner

required

string

Allowed values: platform organization

model

required

string

inputUncached

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

inputCacheRead

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

inputCacheWrite

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

outputText

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

outputReasoning

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

priced

required

boolean

costMicros

required

Any of:

integer
null

integer

<= 9007199254740991

charged

required

boolean

next

required

Any of:

string
null

string

Example

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

400

UsageQueryInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: UsageQueryInvalid

message

required

string

Example

{
  "_tag": "UsageQueryInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BillingUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}