> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nomask.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Account Endpoints

> Read your balance, history and limits programmatically.

Read your balance, usage history and key limits. These endpoints use the same Bearer authentication as completions.

> [card] [Balance](https://docs.nomask.ai/api-reference/balance.md)
>
> Read your available USD balance.

> [card] [Usage](https://docs.nomask.ai/api-reference/usage.md)
>
> Explore request history and filters.

> [card] [Current key](https://docs.nomask.ai/api-reference/me.md)
>
> Inspect the calling key and limits.

Explore the interactive [model list](https://docs.nomask.ai/api-reference/list-models.md) and [single-model lookup](https://docs.nomask.ai/api-reference/get-model.md).

## GET /balance

`GET /balance`

Your account's current prepaid USD balance (shared across all keys).

```json theme={"system"}
{
  "object": "balance",
  "usd": 18.734512
}
```

## GET /usage

`GET /usage`

Paginated usage records for your whole account, newest first. Filter to one key with `?api_key_id=`, a model with `?model=`, or a request type with `?model_type=text` or `?model_type=image`. Pagination uses `page` (default 1) and `per_page` (default 20, clamped to 1–100). Records cover settled text and image requests and contain no prompt or response content.

```bash theme={"system"}
curl "https://api.nomask.ai/v1/usage?per_page=2" \
  -H "Authorization: Bearer $NOMASK_API_KEY"
```

```json theme={"system"}
{
  "object": "list",
  "data": [
    {
      "request_id": "req_01jz...",
      "model": "nomask-1.2",
      "model_type": "text",
      "image_count": 0,
      "reference_images": 0,
      "image_resolution": null,
      "image_format": null,
      "pricing_type": null,
      "usd_per_image": null,
      "prompt_tokens": 21,
      "completion_tokens": 48,
      "usd_cost": 0.000098,
      "streamed": false,
      "tokens_estimated": false,
      "latency_ms": 912,
      "api_key": {"id": 3, "name": "production"},
      "created": 1783140000
    }
  ],
  "page": 1,
  "per_page": 2,
  "total": 1841,
  "has_more": true
}
```

`tokens_estimated` is true when usage was estimated. `usd_cost` is the exact recorded debit. Historical charges retain the original amount recorded at settlement.

## GET /me

`GET /me`

Metadata about the calling key, its monthly spending limit and the default rate-limit profile. Values in the following example are illustrative; read your response for the current account and rate limits. Check each model's `rate_limit` in `GET /models` for its assigned profile.

```json theme={"system"}
{
  "object": "api_key",
  "name": "production",
  "key": "nmk_live_****k3fQp",
  "created": 1783000000,
  "expiration_date": null,
  "has_monthly_limit": true,
  "monthly_usd_limit": 50.0,
  "month_to_date_usd": 12.482716,
  "rate_limit_scope": "per_account",
  "rate_limits": {
    "name": "Default",
    "requests_per_minute": 60,
    "tokens_per_minute": 100000
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.