keys

Create API key

Create a new API key for user authentication and authorization.

Use this endpoint when users sign up, upgrade subscription tiers, or need additional keys. Keys are cryptographically secure and unique to the specified API namespace.

Important: The key is returned only once. Store it immediately and provide it to your user, as it cannot be retrieved later.

Common use cases:

Generate keys for new user registrations
Create additional keys for different applications
Issue keys with specific permissions or limits

Required Permissions

Your root key needs one of:

api.*.create_key (create keys in any API)
api.<api_id>.create_key (create keys in specific API)

Delete API keysDelete API keys permanently from user accounts or for cleanup purposes. Use this for user-requested key deletion, account deletion workflows, or cleaning up unused keys. Keys are immediately invalidated. Two modes: soft delete (default, preserves audit records) and permanent delete. **Important**: For temporary access control, use `updateKey` with `enabled: false` instead of deletion. **Required Permissions** Your root key must have one of the following permissions: - `api.*.delete_key` (to delete keys in any API) - `api.<api_id>.delete_key` (to delete keys in a specific API)

⌘I

Introduction

Endpoints

Create API key