# Retrieve usage

`GET https://stylor.ai/api/v1/usage`

- Authentication: private API key, sent as `Authorization: Bearer sgpt-sk-…::…`
- Rate-limit resource: `api.v1.usage.retrieve`
- Demo key: not accepted
- Web page: https://stylor.ai/guides/rest/v1/retrieve-usage

The organization's plan and what it has used this billing period, for
every endpoint the plan includes, grouped and named as on the dashboard's
usage page. Calls to this endpoint count too.

`quota` and `share` are `null` for an endpoint with no monthly limit.
Endpoints the plan does not include are left out.

## Example request

```bash
curl -X GET "https://stylor.ai/api/v1/usage" \
  -H "Authorization: Bearer $STYLOR_API_KEY"
```

## Responses

### 200

The plan, the period, and the use of each endpoint.

Content type `application/json`:

- `plan` (object, required): The plan the organization is on.
  - `name` (string, nullable): The plan's name, or `null` when it has none.
- `period` (object, required): The billing period the counts are for.
  - `start` (string (date-time)): When the period began.
  - `end` (string (date-time)): When it ends and the counts reset.
- `usage` (array<object>, required): Endpoints grouped as on the usage page. A group with nothing in the plan is left out.
  - `key` (string): The group: `assistant`, `catalogue`, `organization`, or `other`.
  - `title` (string): The group's name.
  - `caption` (string): What the group covers.
  - `items` (array<object>): Each endpoint in the group.
    - `path` (string): The rate-limit resource without `api.`, e.g. `v1.datasets.list`.
    - `label` (string): The endpoint's name on the usage page.
    - `unlimited` (boolean): Whether the plan sets no monthly limit.
    - `quota` (integer, nullable): Calls allowed this period, or `null` when unlimited.
    - `used` (integer): Calls made this period.
    - `share` (number, nullable): `used` over `quota`, 0 to 1, or `null` when unlimited.

Example:

```json
{
  "plan": {
    "name": "Pro"
  },
  "period": {
    "start": "2026-09-14T00:00:00.000Z",
    "end": "2026-10-14T00:00:00.000Z"
  },
  "usage": [
    {
      "key": "assistant",
      "title": "Shopping assistant",
      "caption": "What shoppers use on your store.",
      "items": [
        {
          "path": "v2.agent.chat",
          "label": "Chat messages",
          "unlimited": false,
          "quota": 2000,
          "used": 412,
          "share": 0.206
        }
      ]
    }
  ]
}
```

## Errors

Every error is a JSON object with an `error` string. Match on the status code; the message is written for people.

| Status | Message | When |
| --- | --- | --- |
| 404 | This organization does not have an active subscription. | The organization has no active plan. |
| 404 | No usage found for this billing period. | The plan has no usage record for the current period yet, which happens briefly at renewal. |

### Shared authentication, quota and rate-limit errors

| Status | Message | When |
| --- | --- | --- |
| 401 | API key missing. | The `Authorization` header is absent, is not `Bearer <key>`, or the key does not have three dash-separated segments. |
| 401 | Authentication failed: public key is invalid or not recognized. | A public-key endpoint was called with a key that does not exist. |
| 401 | Authentication failed: private key provided instead of a public key. | A public-key endpoint was called with an `sgpt-sk-…` key. |
| 401 | Authentication failed: token is not recognized. | A private-key endpoint was called with a key whose lookup segment does not exist. |
| 401 | Authentication failed: private key is invalid. | A private-key endpoint was called with a key whose secret does not match. |
| 401 | Authentication failed: public key provided instead of a private key. | A private-key endpoint was called with an `sgpt-pk-…` key. |
| 401 | Authentication failed: bearer token format is invalid. | A private key was sent without its `::` lookup segment. |
| 401 | Authentication failed: API key could not be read. Regenerate the key. | The key's embedded organization data could not be decrypted or parsed. |
| 403 | This key does not have the "<scope>" scope. | A private-key endpoint was called with a key whose scopes do not include the one the endpoint needs. Nothing is counted against your quota. See Authentication. |
| 403 | This key's scopes do not cover this endpoint. | A key with scopes called a private endpoint that no scope grants yet. Give the key every scope to reach it. |
| 403 | Demo mode is not available for private-key routes. Demos are only supported with public API keys. | The demo key was sent to a private-key endpoint. |
| 403 | Demo mode is not supported on this API route. Check the documentation for available demo endpoints. | The demo key was sent to a public-key endpoint that opts out of demo mode. |
| 403 | No active subscription for this organization. | The organization that owns the key has no active subscription. |
| 403 | No quota found for organization "<organizationId>". | The organization has no quota record for the current billing period. |
| 403 | No entitlement for "<resource>". | The plan's quota template has no entry for this endpoint. |
| 403 | Access denied to "<resource>". | The plan's quota template turns this endpoint off. |
| 429 | Monthly quota exceeded for "<resource>" (<quota>/<quota> used). | The billing-period quota for this endpoint is exhausted. `Retry-After` gives the seconds until the period resets. |
| 429 | RPM limit exceeded for "<resource>" (<used>/<limit> used). | More than the allowed requests per minute were sent. `Retry-After` is 60. |
| 500 | Internal server error. | An unexpected failure on the server. The message is always this string; details are logged, never returned. Quota consumed by the request is refunded, as it is for every 5xx response. |