Control plane
Get embedding credits
Returns your organization's embedding credit balance, its one-time trial grant and the number of tokens embedded this calendar month.
GET /v1/embed-credits
- Identify your organizationUse its control-plane API key.
- Read the balanceCheck remaining credit and the trial grant.
- Compare monthly usageToken usage is separate from the remaining credit balance.
Before you start
Use your organization API key on the control-plane origin.
Read the result
balance_micro_usd is the remaining balance in millionths of a US dollar; 1,000,000 equals US$1. month_tokens is usage for the calendar month, not the remaining balance.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 401 | Check the credential and Authorization header. |
| 403 | Check tenant access, roles and permissions. |
| 500 | Check the outcome before retrying a write. |