Overview REST API JavaScript SDK

REST API

HTTP endpoints for collections and rows. Use with your API key (Bearer or x-api-key).

Overview

The API has one route group for integrations:

  • /v1/* — Collections, rows, and real-time (API key required, usage counted)

Authentication

For /v1/*, send your API key:

Header http 
Authorization: Bearer YOUR_API_KEY

Public API (/v1)

Used by your app via the SDK or direct HTTP. All requests count toward your plan's API usage.

Collections

List collections http 
GET /v1/collections

[{"name": "users"}, {"name": "products"}]
Create collection http 
POST /v1/collections

{"name": "users"}

Rows

List rows http 
GET /v1/collections/users/rows?limit=100&offset=0&order_by=id&order=desc

[{"id": 1, "email": "a@b.com"}, {"id": 2, "email": "b@c.com"}]
Insert row(s) http 
POST /v1/collections/users/rows

[{"email": "a@b.com"}, {"email": "b@c.com"}]
Get one row http 
GET /v1/collections/users/rows/1

{"id": 1, "email": "a@b.com"}
Update row http 
PATCH /v1/collections/users/rows/1

{"name": "Alice Updated"}
Delete row http 
DELETE /v1/collections/users/rows/1

Real-time

WebSocket http 
GET /ws?api_key=YOUR_API_KEY&collection=users&events=insert,update,delete

Health

Health check http 
GET /health
# 200 {"ok": true, "service": "onlybase"}