API Reference

REST API

Every indxBASE resource is exposed over a typed, predictable REST API. Try requests from the playground below.

Base URL & authentication

bash

# Base URL
https://api.novaabase.com/v2

# Auth header (use a server-side secret key)
Authorization: Bearer $NOVAABASE_SECRET_KEY

Try it

Interactive API Playground

Endpoints

GraphQL API

query.graphql

query GetPosts($limit: Int!) {
  posts(limit: $limit, order_by: { created_at: desc }) {
    id
    title
    author { id email }
  }
}

Realtime API

realtime.ts

const channel = nb.channel("room:lobby")
  .on("postgres_changes", { event: "INSERT", schema: "public", table: "messages" },
      (payload) => console.log("new message", payload.new))
  .on("broadcast", { event: "cursor" }, ({ payload }) => moveCursor(payload))
  .subscribe();

OpenAPI

Download the full OpenAPI spec to generate clients in any language.