Start Here

Athena Installation Quick Start

Platform

Platform Overview Architecture Architecture Guide Map Routing Model Drivers and Backends Web Explorer WebSocket and CDC Gateway

API

API Overview Gateway API Admin + Management APIs Pipelines + Realtime Webhooks and Public Routes Webhook Events and Deliveries Storage API Security, auth ordering, and rate limits Schema and Introspection Optimization and Admission 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

SDKs

Overview Queries and results Filtering Pagination and limits Sorting Mutations RPC React hook Errors and retries Athena.js SDK API reference Athena RS SDK Rust CLI TypeScript Schema CLI

MCP Server

MCP Overview MCP Tool Categories

Cluster Operations

Cluster Operations Backups + Restore Deployment Troubleshooting

Reference

API Routes API Playground

Documentation Status API root and route listing GET

Liveness probe for the WebSocket gateway GET

Fetch data via GET GET

Run a config-driven pipeline (source → transform → sink) POST

List API registry entries GET

Prometheus metrics endpoint GET

List Athena/Postgres clients (admin) GET Redirect to the hosted Athena docs GET Download the embedded OpenAPI YAML GET Download the embedded WebSocket OpenAPI YAML GET

Admin Api key Default Organization Passkey Two factor Username POST Configuration Options Security Model Error Handling

Athena Auth

Email & Password Sessions Password Management Email Verification

Platform Overview

What Athena is and how teams use it in production.

Athena is a unified gateway and control plane for data-intensive systems.

Primary Responsibilities

Data Access: gateway CRUD routes, SQL, RPC, and REST-compatible endpoints.
Data Automation: pipelines and deferred execution for asynchronous workflows.
Data Operations: backups, restore jobs, provisioning, client lifecycle, and health.
Data Governance: API keys, rights, per-client controls, and audit logging.

Typical Deployment

Configure logical clients in config.yaml and optional catalog tables.
Route requests by X-Athena-Client.
Execute runtime operations through /gateway/*, /query/*, /pipelines, and /management/*.
Operate production workflows through /admin/*, /metrics, and health endpoints.

Key Differentiators

One contract across multiple backends.
Strong operational APIs beyond raw data querying.
SDK and MCP-friendly interfaces for app and agent usage.

Gateway Pool Starvation And Auth Failures

How high gateway throughput against a single instance can exhaust the pool

Architecture

Athena API layer, driver layer, and backend execution model.

On this page

Primary Responsibilities Typical Deployment Key Differentiators

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