API Referenceapi-keys

Create API Key

Create a new API key for an organization (team shared key). Authentication: Requires authenticated user via Auth0/Bearer token Headers: - Authorization: Bearer {auth_token} - User authentication token Parameters: - organization_id: Organization UUID (required) - user_id: User UUID (required) - key_name: Human-readable name for the key (optional, default: 'Default') - tier: API tier (optional, default: 'standard', options: 'standard', 'premium') - environment: Environment scope (optional, default: 'development', options: 'development', 'staging', 'production') - expires_days: Expiration in days (optional, 1-3650) - permissions: Comma-separated permissions (optional, options: 'query', 'index', or both) Returns: - ApiKeyResponse with api_key, management_id, and metadata

Headers

AuthorizationstringRequired
User authentication token

Request

This endpoint expects an object.
organization_idstringRequired
user_idstringRequired
key_namestring or nullOptionalDefaults to Default
tierstring or nullOptionalDefaults to standard
environmentstring or nullOptionalDefaults to development
expires_daysinteger or nullOptional
permissionsstring or nullOptional
created_by_emailstring or nullOptional
created_by_first_namestring or nullOptional
created_by_last_namestring or nullOptional

Response

Successful Response
successboolean
messagestring
management_idstring
api_keystring
created_atstring
key_namestring
errorstring or null
expires_atstring or null

Errors