Skip to main content

Step 1: Create Your App

  1. Go to app.ondb.ai
  2. Create a new App to get your appId
  3. Navigate to the “Security” tab to generate your appKey

Step 2: Install the SDK

TypeScript

Step 3: Initialize the Client

TypeScript

Step 4: Create Indexes

Creating indexes automatically creates the collections and sets up the data structure.
Indexes are Required for Production UseYou MUST create at least one index per collection before storing data. Without indexes:
  • Queries will be extremely slow (full collection scans)
  • The OnDB dashboard cannot display your collections
  • Your application will run in an unoptimized state
TypeScript

Step 5: Store Data

TypeScript

Step 6: Query Data

TypeScript

That’s It!

You now have a fully functional database with indexed queries, automatic payment handling, and built-in data monetization. Optional immutability is available if your use case requires on-chain verification.

Next Steps

Authentication

Learn about App Key and Agent Key authentication

Query Builder

Build complex queries with the fluent API

Payment Flows

Understand USDC payment callbacks

CRUD Operations

Document operations