Sign in
ai-credits

Get AI credit balance.

Changed on

Returns the current AI credit balance for the project. Credits are pooled per workspace — every project in a workspace shares one balance. Only credit counts are returned; token counts, model names, and costs are never exposed.

get/v3/projects/{id}/ai-credits

Request

  • Base URL: https://api.unlayer.com
  • URL: https://api.unlayer.com/v3/projects/{id}/ai-credits
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

The resource ID

Response

Default Response

credits_totalnumber required

Total AI credits available for the current period.

credits_usednumber required

AI credits consumed so far in the current period.

credits_remainingnumber required

AI credits remaining in the current period.

reset_datestring date-time nullable required

When the current credit period resets, or null if there is no active billing period — including once a subscription is cancelled or its term has ended.

Changes

  • 84d147ada26eRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status