SDKs & Integrations
HeliosDB Lite serves the PostgreSQL wire protocol and a REST API.
The HeliosDB client SDKs live in
HeliosDatabase/HeliosDB-SDKs.
They are REST clients for the /v1 API, so they work with Nano and Lite. For
HeliosDB Full, and for SQL against any edition, use a standard PostgreSQL
driver.
For the catalogue and quickstart snippets, see www.heliosdb.com/sdks.html.
Client SDKs
The SDKs are not currently published to PyPI, npm, crates.io or a Go module proxy; install them from the public source repository:
| Language | Package | Install from source |
|---|---|---|
| Python | Python SDK (source only, not on PyPI) | pip install "git+https://github.com/HeliosDatabase/HeliosDB-SDKs#subdirectory=sdks/python" |
| TypeScript / JavaScript | TypeScript SDK (source only, not on npm) | cd HeliosDB-SDKs/sdks/typescript && npm install && npm run build, then npm install /path/to/HeliosDB-SDKs/sdks/typescript in your app |
| Rust | Rust SDK (source only, not on crates.io) | cargo add heliosdb-client --git https://github.com/HeliosDatabase/HeliosDB-SDKs |
| Go | github.com/HeliosDatabase/HeliosDB-SDKs/sdks/go | go get github.com/HeliosDatabase/HeliosDB-SDKs/sdks/go |
Clone the repository first for the TypeScript route:
git clone https://github.com/HeliosDatabase/HeliosDB-SDKs.
The SQLite-compatible Python package (heliosdb-sqlite) lives in the public
HeliosDB-SDKs repository at
sdks/python-sqlite,
but it compiles the HeliosDB-Lite engine, so it must be copied into the licensed
HeliosDB-Lite source tree (contact sales@heliosdb.com
for access) and built there. It is a preview and does not currently build
against the current Lite release; see the
SQLite drop-in guide
for details.
The REST SDKs call the Lite REST API, which requires a JWT signed with
HELIOSDB_JWT_SECRET; see Authentication.
The Python and TypeScript clients take the token directly (jwt_token, jwtToken). The Go
and Rust clients send only an X-API-Key header, which the stock heliosdb-lite start
does not accept; give the Go client an HTTP client that adds the bearer token (see the
Go SDK page).
Several Lite REST endpoint groups (vector stores, documents, agent memory and
chat) are planned, so SDK methods that call them return a not-implemented
error on Lite today. See the REST API Reference.
Because Lite speaks the PostgreSQL wire protocol, any standard PostgreSQL
driver (psycopg, pg, pgx, JDBC, …) also works without an SDK.
CLI
A cross-platform CLI lives under
cli/ in the
same repository. It is not published to npm — note that the unrelated npm
package named heliosdb is not a HeliosDB project.
Platform integrations
VS Code extension · n8n community node · Zapier app · Make (Integromat)
module · Retool REST datasource · Microsoft AutoGen integration. All
under integrations/.
License
All SDKs and integrations are Apache 2.0. Use in commercial, proprietary, or managed-service products without copyleft obligations.