---
title: "Credits and usage"
method: GET
path: "/usage"
tags: ["Account"]
---

# Credits and usage

`GET /usage`

## Request

- Base URL: `https://api.suprememind.ai/v1`
- URL: `https://api.suprememind.ai/v1/usage`
- Auth: HTTP bearer

Requires the `read` scope. The firm's balance and the last 30 days of use, broken down by key.

## Response `200`

Usage.

- Usage
  - `object` 'usage', required
  - `balance` number, required
  - `period` object, required
    - `start` string, date-time
    - `end` string, date-time
    - `days` integer
  - `credits_charged` number, required
  - `credits_refunded` number
  - `by_key` object[], required
    - `key_id` string
    - `name` string
    - `mode` 'live' | 'test'
    - `prefix` string
    - `revoked` boolean
    - `requests` integer
    - `briefs` integer
    - `briefs_succeeded` integer
    - `briefs_failed` integer
    - `credits_charged` number
  - `by_oauth_client` object[]: MCP connectors a person at the firm authorized with OAuth, by client.
    - `client_id` string: The client's record id (oc_...).
    - `name` string, nullable
    - `requests` integer
    - `briefs` integer
    - `briefs_succeeded` integer
    - `briefs_failed` integer
    - `credits_charged` number

## Other responses

- `401`: Missing, malformed, unknown or revoked key.
- `403`: The key lacks the scope, the address is not on its allowlist, or API access is off for the account.
- `429`: Too many requests, or too many jobs in flight.

---

[API](https://skmtc.dev/suprememind/apis/supreme-mind-api.md) · [All operations](https://skmtc.dev/suprememind/apis/supreme-mind-api/llms.txt) · [OpenAPI document](https://skmtc.dev/suprememind/apis/supreme-mind-api/revisions/a7fdd32883bc?raw)