SuperAI Flow Platform

Sections

Theme switcher

Retrieve authentication API key

Retrieve the anonymous authentication key required for client authentication.

Returns the authentication key that client applications need to authenticate with the authentication API at core.flows.super.ai. This key enables clients to perform password-based authentication and obtain JWT access tokens.

Context: - This key is required to make authentication requests to core.flows.super.ai - The key is safe for use in client-side applications (browsers, mobile apps) - Does not grant admin privileges or direct API access - Only enables authentication operations (login, token refresh) - Same key is used across all clients and organizations - Key is long-lived and rarely rotated

Authentication Flow: 1. Client retrieves anonymous key from this endpoint 2. Client sends authentication request to core.flows.super.ai 3. Include anonymous key in 'apikey' header 4. Authentication service validates credentials and returns JWT tokens 5. Client uses JWT access token for subsequent API requests

Use Cases: - Web application initialization requiring user authentication - Mobile app setup for authentication integration - Testing authentication flow in development - Building custom authentication UI - Integrating third-party applications with authentication service

Security Considerations: - This key is public and safe for client-side applications - Does not provide access to user data or administrative functions - Only enables authentication API operations - Users must still provide valid credentials (email/password) - Rate limiting applied at authentication service level - Key rotation handled by platform administrators

Integration Example: After retrieving this key, use it to authenticate users:

Step 1: Get the anonymous key (this endpoint)
Step 2: Use the key to authenticate users at core.flows.super.ai
Step 3: Receive JWT tokens for API access

Related Endpoints: - POST /auth/resend-invite - Resend invitation to existing users - GET /profile/me - Retrieve authenticated user profile - See authentication tag description for complete authentication guide

Error Handling: - Returns 500 if key is not configured on server - Indicates server misconfiguration requiring administrator attention - Contact platform support if persistent errors occur

Response

200
Object
Authentication key successfully retrieved

Response Attributes

anon_keystring Required

Anonymous authentication key for client applications. Use this key to authenticate API requests to the authentication service. Include this in your authentication API calls as the 'apikey' header. This key is safe to use in client-side applications and does not grant administrative privileges. It enables password authentication and token generation for users.

422
Object
Unprocessable Entity - Request validation failed

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
500
Object
Authentication key not configured on server

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot