---
title: "Get information about the authenticated API key"
method: GET
path: "/v1/api-keys/me"
tags: ["API Keys"]
---

# Get information about the authenticated API key

`GET /v1/api-keys/me`

## Request

- Base URL: `https://api.platform.soax.com`
- URL: `https://api.platform.soax.com/v1/api-keys/me`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/soax/apis/soax-api/docs/v1/api-keys/me/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve details about the API key used to authenticate the request: its scopes, package restriction, organization ID, and current rate-limit quota. Useful as a first call to verify a key works, and to check remaining rate-limit quota. This endpoint requires no scope — any active key can call it. The key secret is never returned.

## Response `200`

Successful Response

- GetApiKeyMeResponse: Response schema for GET /v1/api-keys/me endpoint.
  - `id` string, required
  - `scopes` string[], required
  - `package_ids` string[], nullable, required
  - `org_id` string, required
  - `rate_limit` RateLimitInfo, required: Rate limit information for an API key.
    - `configured_limit` string, required
    - `remaining_quota` integer, required

## Other responses

- `401`: Missing, invalid, or revoked API key.
- `429`: Rate limit exceeded (5 requests/second per API key, 500 requests/minute per IP). The response includes `Retry-After` (seconds), `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix time) headers — wait `Retry-After` seconds and retry.

---

[API](https://skmtc.dev/soax/apis/soax-api.md) - [All operations](https://skmtc.dev/soax/apis/soax-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soax/apis/soax-api/revisions/2abdaa934277?raw)