AI Usage
Getting started
Who can use the AI Usage API
- The AI Usage API is only available to organizations on the Enterprise plan.
- Only organization administrators can create the plan access tokens required to query the AI Usage API.
The AI Usage API lets you fetch per-user, per-day AI credit usage for your organization's plan. Each row reports the seat-level and plan-level credits a user consumed on a given day, along with the container (workspace, team, and license group) the usage was attributed to.
With the AI Usage API, you can:
- Track AI credit consumption across your organization over time.
- Attribute usage to individual users, workspaces, teams, and license groups.
- Build internal reporting and chargeback workflows on top of AI credit usage.
info
AI usage data is updated on a periodic schedule and can lag real-time activity by up to 5–6 hours. Recent usage—including usage from the current day—may not yet be reflected in the response.
To make requests to the AI Usage API, your access token must include the org:ai_metering_usage_read scope. This endpoint can only be used with a plan access token.
The following table describes the requirements.
GET | |
|---|---|
| Plan | Enterprise |
| Account type | Organization administrator |
| Token type | Plan access token |
| Token scopes | org:ai_metering_usage_read |