REST API · v0.10.0

The River REST API

One HTTP API for every part of River — federated queries, managed databases, notebooks, BI, and more. 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/api/v1

Credentials

Fill in your workspace to personalise every example

Your Workspace ID and API key are substituted into the code samples and “Try It” requests. Stored locally in your browser only.

Command line

Install the River CLI

The river CLI wraps the same API — queries, connections, notebooks, jobs, containers, databases and more — in your terminal. It is published as a public npm package on npm.

Install via npm — no token required

bash
npm install -g @brian-bill/river
river --help

# store credentials in ~/.river/config.json
river auth login
river connections list

Same name on every package manager: pnpm i -g @brian-bill/river or yarn global add @brian-bill/river work too.

HTTP API Reference

REST API v0.10.0

Base URL: https://<workspace-id>.river.li/api/v1. Every request must include x-api-key: rqk_…. Public endpoints () need no key.

Connections

8 endpoints

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