DevelopersDocumentation

Developer Documentation & SDK Reference

Comprehensive setup manuals, API client libraries, SQL schema design guides, and Edge runtime references.

Open Developer DocsView Pricing
API Playground Console
GEThttps://api.extrabase.io/v1/docs
200 OK
Response Headers
{
  "content-type": "application/json",
  "cache-control": "no-cache",
  "x-extrabase-version": "v1.0.4"
}
Response Body JSON
{
  "project": "extrabase-prod",
  "region": "us-east-1",
  "database": {
    "version": "PostgreSQL 15.2",
    "active_connections": 18,
    "status": "healthy"
  }
}

Architecture & Design

Welcome to the official ExtraBase Developer Documentation. Here you will find quickstart guides, language-specific client libraries, and advanced references to help you build and scale your applications. Whether you are setting up secure database row-level policies, invoking serverless edge processes, managing media asset buckets, or connecting real-time updates via WebSockets, our documentation has code samples and complete tutorials to guide you.

Documentation Pillars

  • Quickstart Guides
  • SDK Client References
  • SQL Policies & RLS
  • Edge runtime manuals
  • Storage CDN controls
  • CLI Command Dictionary

Documentation & Reference Manuals

  • Quickstart Installation: Guides for integrating ExtraBase client SDKs into React, Next.js, Vue, Svelte, Flutter, and iOS/Android native projects.
  • JavaScript & TypeScript SDK Reference: Detailed API spec for initializing the client, selecting rows, performing bulk inserts, uploading files, and listening to active channels.
  • Postgres Database Administration: Understanding Postgres configurations, connection limits, query tuning with EXPLAIN, and extensions management (pgvector, PostGIS).
  • Row Level Security (RLS) & Policies: Learn how to write secure SQL policies to validate JWT tokens and shield sensitive client tables from unauthorized requests.
  • Serverless Edge Functions SDK: Manuals on writing globally-distributed TypeScript runtimes, handling HTTP CORS headers, and importing external modules.
  • CDN Object Storage Buckets: Organizing asset folders, configuring caching durations, setting up public vs private access buckets, and auto-transforming images.
  • CLI Command Reference Dictionary: Deep-dive commands list for local Docker stack emulation (`extrabase start`), migration generation (`db diff`), and remote deployment configs.