Skip to content

Credits

GET /v1/credits

Returns the current Hypercredit balance for the authenticated team. Requires authentication.

Hyper uses Hypercredits as its unit of account. Every user gets 100 Hypercredits per month for free.

Request

bash
curl https://hyper.charm.land/v1/credits \
  -H "Authorization: Bearer sk-hyper-xxxxxxxxxxxxxxxxxxxxxxxx"

Response

json
{
  "balance": 100
}

Pricing

Token costs vary by model. Check the model catalog or the /v1/models endpoint for per-model pricing in dollars per million tokens.

Errors

json
{
  "error": {
    "message": "...",
    "type": "...",
    "code": null
  }
}
Statuserror.typeCause
401authentication_errorMissing or invalid API key
5xxserver_errorInternal error