Skip to main content
The @oleanderhq/sdk package provides a typed client for the oleander API. It covers lake queries, Spark job management, Spark SQL, Polars runs, catalog introspection, environment variables, Spark cluster lookup, and run polling.

Installation

Authentication

Create an API key in your oleander settings, or run oleander configure if you use the CLI. You can pass the key directly or, in Node.js, set the OLEANDER_API_KEY environment variable.

Quick start

Working with clusters

Use cluster: "oleander" for oleander-managed Spark or pass the name of a registered cluster when submitting a job.

Constructor options

Errors

The SDK throws structured HTTP errors for non-2xx responses.