SDK Reference

Query Builder

Database Manager

Health check endpoint with comprehensive system verification GET /health

List all registered applications from OnDB storage

Updated create application endpoint with financial integration and OnDB storage Requires payment proof via X-PAYMENT header

Get application details GET /api/applications/:app_id

Update creator premium settings for an app

Store blob endpoint - Upload binary data (images, videos, files, etc.) POST /api/apps/:app_id/blobs/:collection

Retrieve blob endpoint GET /api/apps/:app_id/blobs/:collection/:blob_id

Handler for SQL INSERT statements

Store data endpoint - app::collection based only POST /store

List all collections for an app GET /api/apps/:app_id/collections

Create a new collection POST /api/apps/:app_id/collections

Get a specific collection GET /api/apps/:app_id/collections/:collection_id

Delete a collection DELETE /api/apps/:app_id/collections/:collection_id

Patch apiapps collections

Update collection sharding configuration PATCH /api/apps/:app_id/collections/:collection_name/sharding

Auto-generated collection query endpoint GET /api/apps/:app_id/collections/:collection/data

Get retention configuration for a collection GET /api/apps/:app_id/collections/:collection/retention

Set retention configuration for a collection POST /api/apps/:app_id/collections/:collection/retention

Get retention costs for all collections in an app GET /api/apps/:app_id/retention/cost

Get encryption settings for an app GET /api/apps/:app_id/encryption

Update encryption settings for an app (x402 payment flow) POST /api/apps/:app_id/encryption

Get quote for encryption feature changes POST /api/apps/:app_id/encryption/quote

Get all indexes for an app GET /api/apps/:app_id/indexes

Create an index for an app POST /api/apps/:app_id/indexes

Get quote for creating an encrypted index (x402 flow) GET /api/apps/:app_id/indexes/encrypted-quote

Delete an index DELETE /api/apps/:app_id/indexes/:index_id

Create a collection relation and automatically index join fields POST /api/apps/:app_id/relations

List all API keys for an app POST /api/apps/:app_id/keys/list

Revoke a specific API key POST /api/apps/:app_id/keys/:key_hash/revoke

Regenerate an app API key (invalidates the old one) Or generate initial key if app doesn't have one yet POST /api/apps/:app_id/regenerate-key

Register a new user API key POST /api/auth/register

Get payout history POST /api/apps/:app_id/payout/history

Get payout settings and available balance POST /api/apps/:app_id/payout/info

Update payout settings POST /api/apps/:app_id/payout/settings

Trigger a manual payout POST /api/apps/:app_id/payout/trigger

Get app wallet information GET /api/apps/:app_id/wallet

Get app wallet transactions GET /api/apps/:app_id/wallet/transactions

Get authz transaction history for an app GET /api/authz/transactions/app/:app_id

Get recent authz transactions (admin/monitoring) GET /api/authz/transactions/recent?limit=50

Get authz transaction history for a user GET /api/authz/transactions/:user_address

Get current pricing information

Post apipricingquote

Execute a predefined query with parameters GET /api/queries/:app_id/:query_name/data

Get Skills.md for discovery (reads from disk) GET /api/skills/:app_id/skills.md

List all predefined queries for an app GET /apps/:app_id/queries

Create a new predefined query POST /apps/:app_id/queries

Get a specific predefined query definition GET /apps/:app_id/queries/:query_name

Delete a predefined query DELETE /apps/:app_id/queries/:query_name

GET /api/views/:app_id/:view_name/count Get count of records in view (useful for pagination)

GET /api/views/:app_id/:view_name/data Simple query with URL parameters

POST /api/views/:app_id/:view_name/data Complex query with request body (full Scepter query syntax)

List all collections for an app (including API collections) GET /apps/:app_id/api_collections

Create a new API collection POST /apps/:app_id/api_collections

Get API collection details GET /apps/:app_id/api_collections/:collection_name

List all materialized views for an app GET /apps/:app_id/views

Create a new materialized view POST /apps/:app_id/views

Handler for SQL CREATE MATERIALIZED VIEW statements

Get a specific materialized view GET /apps/:app_id/views/:view_name

Delete a materialized view DELETE /apps/:app_id/views/:view_name

Manually refresh a materialized view POST /apps/:app_id/views/:view_name/refresh

List records with QueryExecutor POST /list

Handler for SQL queries

Get task status by ticket ID GET /api/tasks/:ticket_id

POST /x402/settle - Execute and confirm payment

GET /x402/supported - List supported payment schemes

POST /x402/verify - Validate payment without executing