OMomni
AI Credit Usage

Read individual entity groups' AI credit usage

Changed on
<Note> **Organization Admin** permissions are required to use this endpoint. </Note>

List individual embed entity groups' (up to 1,000 unique entities per request) AI credit usage for the current billing period. Each included entity must have an entity group in the organization. Unknown, invalid, and duplicate entity values will fail the request.

Returns each entity group's credits used, in request order, plus the billing-period bounds. Entity groups with no current usage will report 0.

post/v1/ai/credit-usage/entity-groups

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/credit-usage/entity-groups
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

entitiesstring[] 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.

Example request

{
  "entities": [
    "blobsrus"
  ]
}

Response

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

periodEndinteger required

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

periodStartinteger required

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

Example response

{
  "entityGroups": [
    {
      "creditsUsed": 42,
      "entity": "blobsrus"
    }
  ]
}

Changes