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

# Check your API key

> GET /api/v1/me: confirm an API key works and see its limits, without sending or spending anything.

```http theme={null}
GET https://www.clearaml.com.au/api/v1/me
```

Confirms the key works and shows what it may do. Nothing is sent or charged. Every refusal a real request would get (API access switched off, the firm's billing, the key's IP allowlist) shows up here too, so it is a good first test of your setup.

## Response

```json theme={null}
{
  "firm": { "name": "Example Legal Pty Ltd" },
  "api_key": {
    "name": "Website signup form",
    "prefix": "clr_live_1a2b3c4d",
    "scopes": ["onboarding_invites:create"],
    "daily_limit": 20,
    "used_today": 3
  },
  "request_id": "…"
}
```

* `prefix` is the start of the key, as the firm sees it in ClearAML. The key itself is never returned.
* `used_today` counts invitations sent today (Sydney time) against `daily_limit`.

## Example

```bash theme={null}
curl https://www.clearaml.com.au/api/v1/me \
  -H "Authorization: Bearer $CLEARAML_API_KEY"
```

This endpoint allows 30 requests per minute per key.


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