Sign in

v1

latestOpenAPI 3.1.02026-08-04134182237.9 KB
API Keys

Create Api Key

Create a new API key.

  • name: Display name for the key
  • scope: API key scope (user or enterprise; demo is admin-only)
  • daily_limit: Optional daily request limit (NULL = unlimited)
  • expires_at: Optional expiration date (NULL = 30 days from now)

Enterprise keys (scope=enterprise):

  • Require admin approval before activation
  • Use postpaid billing (monthly invoicing)
  • Require company_name and request_message
  • Get Business subscription access + unlimited rate limits

Important: The plain key is only shown once! Store it securely.

post/api/api-keys

Request body

namestring required

Display name for the key

scope'demo' | 'user' | 'enterprise'
daily_limitinteger nullable

Optional daily request limit (NULL = unlimited). Use for testing or rate-limited access.

expires_atstring date-time nullable

Key expiration date (NULL = never expires, default = 30 days from now)

request_messagestring nullable

Message explaining the reason for requesting API access. Required for enterprise keys.

company_namestring nullable

Company name (required for enterprise keys)

expected_monthly_usagenumber nullable

Expected monthly usage in USD (helps set credit limit for enterprise keys)

Response

Successful Response

successboolean
messagestring nullable