usage.getUsage

GET

/v1/organization/usage

const url = 'https://example.com/v1/organization/usage?groupBy=day';
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?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

token
session

Parameters

Query Parameters

from

string

groupBy

string

Allowed values: day model provider member bot token source

Responses

200

Success

application/json

object

from

required

string

required

string

groupBy

required

string

Allowed values: day model provider member bot token source

total

required

object

calls

required

integer

>= -9007199254740991 <= 9007199254740991

pendingCalls

required

integer

>= -9007199254740991 <= 9007199254740991

unknownCalls

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
null

string

calls

required

integer

>= -9007199254740991 <= 9007199254740991

pendingCalls

required

integer

>= -9007199254740991 <= 9007199254740991

unknownCalls

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

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