Skip to main content
The official @instantlyai/sdk package provides typed access to the Instantly API from TypeScript or JavaScript.
The SDK is currently in beta. Its concise resource API may receive minor refinements before the stable 1.0.0 release.

​
Why use the SDK?

Typed resources

Use generated request and response types in your editor.

Concise methods

Call resource methods such as instantly.campaigns.list() and instantly.campaigns.create().

API coverage

Access resource namespaces generated from the Instantly OpenAPI schema.

Flexible client

Configure the base URL, headers, middleware, or a custom fetch implementation.

​
Requirements

  • Node.js 22 or later.
  • An Instantly workspace with an API v2 key.
Keep your API key in a secure server-side environment. Do not include it in browser bundles or public source code.

​
Next steps

SDK quickstart

Install the package and list your campaigns.

View on npm

Check the package version, README, and release details.