Documentation

Learn once, build anything.

One SDK. Everything you need. Auth, billing, AI, analytics, and more—all through a unified API.

I'm new → Quick Start I know the basics → API Reference Show me examples

Quick Start

Get your first auth flow running in 5 minutes

API Reference

Complete SDK documentation

UI Components

Pre-built SignIn, Protect, and more

Getting Started

Quick Start

Get running in 5 minutes

Installation

Install the SDK

Configuration

Configure credentials

UI Components

Pre-built React components

Authentication

Overview

Auth components and hooks

Email/Password

Traditional auth

OAuth Providers

Google, GitHub, Apple

Two-Factor Auth

TOTP-based 2FA

Components

Auth UI components

Billing

Overview

Billing overview

Plans & Pricing

Define subscription tiers

Checkout

Payment integration

Subscriptions

Manage subscriptions

Webhooks

Handle billing events

Components

Billing UI components

AI Services

Overview

AI services overview

Chat Completions

200+ models, one API

Embeddings

Vector embeddings

Image Generation

DALL-E, Stable Diffusion

Available Models

Model catalog

API Reference

REST API docs

Usage & Quotas

Monitor costs

Components

AI UI components

Analytics

Overview

Analytics overview

Event Tracking

Track custom events

User Identity

Identify users

Querying

Query analytics data

Destinations

Export destinations

Components

Analytics UI components

Storage

Overview

Storage overview

File Uploads

Upload files

Access Control

Public vs private

Components

Storage UI components

Database

Overview

Database overview

Query Guide

Query patterns

Migrations

Schema migrations

Transactions

Transaction handling

Optimization

Performance tips

KV Store

Overview

Key-value store

Data Structures

Hashes, lists, sorted sets

Rate Limiting

Sliding window rate limiter

Realtime

Overview

Pub/sub messaging

Message History

Stream replay

Multi-Channel

Subscribe to multiple channels

Search

Overview

Semantic & full-text search

Indexing

Index documents

Querying

Search queries

Monitoring

Overview

Error tracking

Error Grouping

Error aggregation

Alerting

Alert rules

Source Maps

Upload source maps

Components

Monitoring UI components

Background Jobs

Overview

Background jobs

Cron Guide

Scheduled tasks

Workflows

Multi-step workflows

Retry Strategies

Error handling

Components

Jobs UI components

Notifications

Overview

Push notifications

FCM Setup

Firebase Cloud Messaging

APNS Setup

Apple Push Notifications

Scheduling

Scheduled notifications

Segmentation

User segments

Components

Notification UI components

Feature Flags

Overview

Feature flags

Local Evaluation

Client-side evaluation

Targeting Rules

User targeting

A/B Testing

Experiments

Components

Flag UI components

Consent

Overview

Consent management

GDPR Guide

GDPR compliance

CCPA Guide

CCPA compliance

Preference Center

User preferences

Components

Consent UI components

Organizations

Overview

Multi-tenancy

Members

Member management

Invitations

Team invites

Roles

RBAC

Components

Org UI components

Referrals

Overview

Referral program

Tracking

Referral tracking

Reward System

Rewards

Analytics

Referral analytics

Components

Referral UI components

Engagement

Overview

Gamification

Leaderboards

Rankings

Achievements

Badges

Streaks

Daily streaks

Components

Engagement UI components

Webhooks

Overview

Webhook integration

Event Reference

Event types

Security

Signature verification

Testing Guide

Testing webhooks

Components

Webhook UI components

Email

Overview

Email services

Newsletter management

Deploy

Overview

Deploy from GitHub

Preview Deployments

PR preview URLs

Custom Domains

Bring your own domain

Environment Variables

Env config

CI Runner Settings

Org & repo JIT runner config

Backup

Overview

Backups & versioning

Database Backups

pg_dump automation

Storage Versioning

Object version history

Reference

API Reference

Complete API docs

Examples

Code examples

SDK at a Glance

React Hooks

useUser, useAuth, useBilling, useAnalytics, useChat, useStorage, usePush, useReferral, useJobs, useConsent

50+ UI Components

SignIn, UserProfile, ChatInterface, AnalyticsDashboard, FileUpload, JobScheduler, CookieBanner, ErrorBoundary, WebhookManager, and more...

Server

auth(), currentUser(), authMiddleware(), handleCallback(), createPlatformAPI()

Need Help?

Join our community or contact support for assistance.