Admin API

The Admin API gives enterprise administrators programmatic, read-only access to administrative data. Use it to build internal usage reports and export data to your analytics systems.

Admin API credentials are deliberately separate from the keys used to generate images and videos. An Admin read-only key cannot generate media or spend credits. A generation key cannot call Admin API endpoints.

Availability

Admin read-only keys are available to administrators of top-level enterprise accounts. A key belongs to the account where it was created and can report usage for that account and all its subteams.

Keys cannot be created for an individual subteam. If the Admin read-only keys section does not appear in Developer settings, the selected account is not eligible or you do not have administrator access.

Create an Admin read-only key

1. Open Developer settings.
2. Select the top-level enterprise account you want to monitor.
3. Find the Admin read-only keys section and select New Read key.
4. Give the key a name that identifies the integration using it.
5. Create the key and copy the secret when it is shown.
6. Store the secret safely.

The full secret is shown only when the key is created. If it is lost, create a replacement and revoke the old key.

Available endpoints

Endpoint	Description
GET /v1/team/usage-breakdown	Get enterprise credit usage grouped by subteam, user, board, project, product, model, media, role, or calendar period.

Operate keys safely

• Create a separate key for each integration so it can be revoked independently.
• Give every key a descriptive name that identifies its owner and purpose.
• Treat the secret as a credential even though the key is read-only and cannot spend credits.

Continue to the usage-breakdown reference for every query parameter, response field, and error condition.