API Reference

Node SDK

The Node SDK wraps hosted SQL, sessions, capabilities, proposals, and backups for JavaScript apps.

Overview

Use the Node SDK when it is available in your beta environment.

Keep keys on the server side.

Use TypeScript examples as the canonical public shape.

Developer notes

Keep API calls on the server side of your app.
Set tenant and principal through session context.
Use proposal capabilities for risky writes.
Handle LIMIT_EXCEEDED and BILLING_REQUIRED as expected beta states.

Install and connect

TypeScript

import { Synapsor } from "@synapsor/client";

const db = await Synapsor.connect("https://synapsor.ai", {
  // Keep API keys server-side; do not expose them in browser bundles.
  apiKey: process.env.SYNAPSOR_API_KEY,
});

// Session values come from your authenticated backend context.
db.setSession({ tenant_id: "acme", principal: "agent_1" });
console.log(await db.query("SELECT 1;"));

Examples

bash

npm install @synapsor/client