GET/desk/api/v2/ai/usage.json

Get AI add-on usage for the current installation.

Both metered streams for the current billing period. state is "ok", "warning" (at 80% of the allowance) or "exhausted"; an allowance of 0 means no add-on. resetDate is the next payment date.

Responses

Code
200
Type
object
Schema
Description
200 OK
Code
400
Type
object
Schema
Description
400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

AIUsageAPIBody

{
  "aiUsage": {
    "replies": {
      "allowance": 0,
      "resetDate": "2026-08-20T11:07:57.837Z",
      "state": "string",
      "used": 0
    },
    "summaries": {
      "allowance": 0,
      "resetDate": "2026-08-20T11:07:57.837Z",
      "state": "string",
      "used": 0
    }
  }
}

Download Swagger