Get API Key Details

Auth context for the current API key, including the workspace it resolves to, current rate-limit tier, and allowed endpoints.

Tip: Call this before a batch run as a health check. The response confirms that your key is valid, which workspace it resolves to, the rate limit tier, and which endpoints the key is allowed to hit.

Endpoint

GET /api/v1/account/key-info

Authentication

All requests require the X-Satellyte-API-Key header. See Quickstart.

Request

No body or query parameters.

cURL

curl -i "https://api-staging.satellyte.ai/api/v1/account/key-info" \
  -H "X-Satellyte-API-Key: $API_KEY"

Response (200)

{
  "data": {
    "valid": true,
    "public_api_enabled": true,
    "auth": {
      "type": "api_key",
      "subject": "H7OthRb1CSy0Q1OYS5u5H",
      "key_header": "X-Satellyte-API-Key"
    },
    "workspace": {
      "id": "OWPayiJ2iK6dIZ4VOFxkP",
      "user_id": "H7OthRb1CSy0Q1OYS5u5H",
      "role": "admin",
      "email": "support@example.com"
    },
    "tier": "starter",
    "rate_limit": {
      "enabled": true,
      "strategy": "SIMPLE_API_KEY_LIMIT",
      "simple": { "requests": 100, "window": "1m" },
      "tiers": { "default": "100/m", "starter": "300/m", "growth": "1000/m" }
    },
    "allowed_endpoints": [
      "GET /api/v1/health",
      "POST /api/v1/discover/companies",
      "POST /api/v1/enrich/email"
    ],
    "generated_at": "2026-05-11T07:52:12.938Z"
  }
}

Response fields

Field	Type	Notes
`valid`	boolean	Whether the API key context is valid.
`public_api_enabled`	boolean	Whether Public API access is enabled for this workspace.
`auth`	object	Auth metadata (type, subject id, header name).
`workspace`	object	The workspace this key resolves to.
`tier`	string	Current billing/rate-limit tier (`default`, `starter`, `growth`).
`rate_limit`	object	Strategy and tier-level rates.
`allowed_endpoints`	string[]	Endpoint capability list for this key.
`generated_at`	string	ISO timestamp when the response was generated.

Error responses

All failed calls use the standard error envelope documented in Errors.

Status	Code	Notes
`401`	`unauthorized`	Returned when `X-Satellyte-API-Key` is missing, invalid, or expired.
`404`	`not_found`	Returned when Public API access is not enabled or the API key context cannot be resolved.
`429`	`rate_limit_exceeded`	Returned when the API key exceeds its configured rate limit.
`500`	`service_error`	Returned when Satellyte cannot load the API key context. Retry with backoff.