Harmont docs
Cloud SDK

Cloud SDK

A typed TypeScript client for the Harmont API, generated from the OpenAPI spec.

Harmont is in limited access

The Harmont API is not yet open to the public. Endpoints require an account, granted from the waitlist. Request access at harmont.dev. The SDK and reference below are published so you can build against the contract ahead of time.

@harmont/cloud is the official TypeScript SDK for the Harmont API. It is generated from the same OpenAPI spec that backs the REST reference, so its functions and types mirror the API exactly — one function per endpoint, fully typed request and response shapes.

Install

npm install @harmont/cloud

The SDK is built on a small fetch-based client and ships as both ESM and CommonJS with TypeScript declarations. It targets Node 18+ and any modern browser or bundler.

What's inside

Relationship to the REST API

The SDK is a thin, typed wrapper — there is no behaviour it adds beyond the HTTP contract. Anything documented in the API reference (auth, error envelope, rate limits) applies unchanged. When in doubt about a field, the API reference is the schema-level source of truth; the SDK reference shows the TypeScript surface.

On this page