Skip to main content
POST
Read individual entity groups' AI credit usage

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
entities
string[]
required

Entity groups to read usage for, at most 1000 per request. Each entry is an embed entity (the SSO entity value) corresponding to an entity group in the organization. Each entity must be included only once, as duplicated entries will fail the request.

Required array length: 1 - 1000 elements

Response

Each requested entity group's credit usage for the current billing period, in request order.

periodEnd
integer
required

End of the current billing period as a Unix ms timestamp (UTC calendar-month boundary).

Required range: x >= 0
periodStart
integer
required

Start of the current billing period as a Unix ms timestamp (UTC calendar-month boundary).

Required range: x >= 0
entityGroups
object[]
required