API v0.9.0 · 7 SDKs

Build with River

Seven idiomatic client libraries and a full HTTP REST API. Every request authenticates with an x-api-key: rqk_… header. Every endpoint is RBAC-gated.

x-api-keyrqk_… header
Base URL<workspace-id>.river.li/v1
SDK / TypeScript

river-typescript

Official River client for TypeScript.

GitHub

01 — Install

bash
npm install river-typescript

02 — Initialise client

typescript
import { Configuration, DefaultApi } from 'river-typescript';

const api = new DefaultApi(new Configuration({
  basePath: 'https://<workspace-id>.river.li/v1',
  apiKey: 'rqk_your_api_key',
}));

03 — Run a federated query

typescript
// Federated SQL across every connected source
const result = await api.queryPost({
  queryPostRequest: {
    sql: 'SELECT * FROM pg.public.orders LIMIT 20',
  },
});

console.log(result.rows);

// Chat with Lily
const reply = await api.aiLilyPost({
  aiLilyPostRequest: {
    messages: [{ role: 'user', content: 'Summarise orders from last week' }],
  },
});

Full API surface

Every endpoint available in this SDK — browse the HTTP API reference.

Ready to build?

Get your first API key in under a minute.

Deploy River on your own hardware, connect your databases, and start querying across every source with a single request.

Get startedGitHub