Start Here

Athena Installation Quick Start

Repository + App Map

Repository + Application Map Athena Client Pressure Crate Athena Actix Crate Athena CDC Crate Athena Driver Crate Athena WSS Crate Athena Gateway Crate Athena Observability Crate Athena Query Crate Athena Pipelines Crate Athena Typesense Crate Athena API Key Crate Athena Webhooks Crate

Athena Server (Rust)

Athena Server Platform Platform Overview Athena Contracts Architecture Daemon Runtime Architecture Guide Map Routing Model Drivers and Backends Web Explorer WebSocket and CDC Gateway

API

API Overview Gateway API Gateway Structured Select Direct PostgreSQL Routing (`x-pg-uri`)Admin + Management APIs Pipelines + Realtime Webhooks and Public Routes Tenant Wildcard Hostnames Webhook Events and Deliveries Storage API Typesense Search + Sync Security, auth ordering, and rate limits Schema and Introspection Optimization and Admission Table Row Estimates Management DDL and Functions RPC and REST Compatibility

Gateway API Keys

Gateway API Keys Format, Storage, and Lifecycle Rights and Client Binding IP Whitelists, Blacklists, and Precedence Virgin Keys and Lock-In Enforcement, Fail Modes, and Availability Full Implementations and Admin Recipes Troubleshooting

Cluster Operations

Cluster Operations Clone Jobs Backups + Restore Deployment Troubleshooting

MCP Server

MCP Overview MCP Tool Categories

SDKs

JavaScript / TypeScript

Athena.js SDK Getting Started Overview Athena JS Type Surface Manifest API Reference Complete SDK Method Reference Athena.js Snippet Catalog

Athena Server Data/Gateway

Queries and results findMany AST and server contract Select column aliases Filtering Pagination and limits Sorting Mutations RPC Typed Schema Registry Generator Configuration Experimental options

Athena Auth Client

Athena Auth Client Auth Sign In and Sign Up Auth Session Auth User Lifecycle Auth Social and Provider Accounts Auth Two Factor Auth Passkey Auth Admin Auth API Key Auth Organization Auth Organization Members Auth Organization Invitations Auth Callback React useSession

React/Operational

React hook Errors and retries Athena Auth UI Customization Guide Components AccountSettings AccountSettingsPage ActiveSessions AdditionalField AdminCredentialsCard ApiKeys Appearance AuditLogCard Auth AuthPage AuthProvider AuthUiProvider ChangeEmail ChangePassword DangerZone DeleteUser DocumentsCard EmailChangedEmail EmailComposerCard EmailFailuresCard EmailTemplatesCard EmailVerificationEmail ForgotPassword ForgotPasswordPage InboxCard LinkedAccounts MagicLink MagicLinkEmail ManageAccount ManageAccounts NewDeviceEmail NotificationsCenterCard OAuthAccountsCard OrganizationCenterCard OrganizationInvitationEmail OrganizationSettings OtpEmail Passkeys PasswordChangedEmail PastEmailsCard ProviderButton ProviderButtons ResetPassword ResetPasswordEmail ResetPasswordPage SdkMethodLabCard SecuritySettings SecuritySettingsPage Settings SettingsPage SignIn SignInPage SignInUsername SignOut SignOutPage SignUp SignUpPage SwitchAccountSubmenu SwitchAccountSubmenuContent SwitchAccountSubmenuItem ThemeToggleItem UserAvatar UserButton UsernameField UserProfile UserView WorkspaceActivityFeedCard WorkspaceCommunicationsPanel WorkspaceCommunicationsSettings WorkspaceControlsCard WorkspaceDocumentsPanel WorkspaceDocumentsSettings WorkspaceLogsPanel WorkspaceLogsSettings WorkspaceNotificationsPanel WorkspaceNotificationsSettings WorkspaceOperationsPanel WorkspaceOperationsSettings WorkspaceSdkLabPanel WorkspaceSdkLabSettings WorkspaceSectionCard WorkspaceSecurityPanel WorkspaceSecuritySettings WorkspaceSettings Hooks useAdminAthenaClients useAdminAuditLogs useAdminAuditLogsQuery useAdminEmailFailures useAdminEmailFailuresQuery useAdminEmailTemplates useAdminEmailTemplatesQuery useAdminPastEmails useAdminPastEmailsQuery useAuthUiOptions useCreateAdminApiKey useCreateAdminAthenaClient useCreateAdminEmailFailure useDeleteAdminEmailFailure useDeleteAdminEmailRecord useDeleteEmailTemplate useFetchOAuthTokens useResolvedAuthUiOptions useUpdateAdminEmailFailure useUpsertAdminEmailRecord useUpsertEmailTemplate useWorkspaceRuntime useWorkspaceSession Functions apiKeyPlugin buildMethodCandidates deleteUserPlugin getAthenaAuthEmailTemplate getAthenaAuthEmailTemplateCatalog magicLinkPlugin methodCategory multiSessionPlugin normalizeMethodPath organizationPlugin passkeyPlugin themePlugin usernamePlugin withAthenaAuthEmailTemplate workspacePlugin Entrypoints Compat Core Compat Core Plugins Compat React Compat React Email @xylex-group/athena-auth-ui/email @xylex-group/athena-auth-ui/pages @xylex-group/athena-auth-ui/plugins @xylex-group/athena-auth-ui Styles GettingStarted

Rust

Kubernetes / Operator

Athena Operator Getting Started Kubernetes Primer Local Cluster On Windows Install Operator Deploy Gateway Using An Existing AthenaClient Create An AthenaClient API Keys Troubleshooting

CLI Tooling

Rust CLI TypeScript Schema CLI

Athena Auth Server (Rust)

Athena Auth Core Email & Password Sessions Password Management Email Verification Athena Auth Plugins OAuth / Social Login Two-Factor Authentication Organization Admin API Key Passkey Athena Auth Concepts Configuration Plugins Database Middleware Database Hooks Users & Accounts OAuth Email Rate Limiting Cookies Athena Auth Integrations Axum Standalone Server

Reference

Reference & Contracts API Routes API Playground Configuration Options Security Model Error Handling Documentation Status

Athena Server OpenAPI

API root and route listing GET

Structured health check with local provisioning diagnostics GET

Fetch data via GET GET

Run pipeline POST

List full schema metadata for one schema (defaults to public) GET

API registry GET

Prometheus metrics endpoint GET

List Athena clients (protected) GET Documentation redirect GET OpenAPI spec GET WebSocket OpenAPI spec GET

Athena Auth OpenAPI

OpenAPI spec

GET

/openapi.yaml

Response Body

`application/yaml`

curl -X GET "https://athena-cluster.com/openapi.yaml"

"string"

Empty

Documentation redirect GET

Previous Page

WebSocket OpenAPI spec GET

Next Page

Athena documentation for gateway APIs, SDK integrations, MCP workflows, and cluster operations.