Quickstart

Install the SDK, authenticate with an API v2 key, and list campaigns in your workspace.

Prerequisites

Node.js 22 or later.
An Instantly workspace with an API v2 key.

The SDK is currently in beta. Install it with the beta tag until the stable 1.0.0 release is available.

Install the SDK

Add the package to your Node.js project:

npm install @instantlyai/sdk@beta

Set your API key

Store your API key in a server-side environment variable:

export INSTANTLY_API_KEY="your-api-key"

Never expose your API key in client-side code or commit it to source control.

Create a client

Import Instantly, create a client, and list up to 10 campaigns:

import { Instantly } from '@instantlyai/sdk';

const apiKey = process.env.INSTANTLY_API_KEY;

if (!apiKey) {
  throw new Error('INSTANTLY_API_KEY is not set');
}

const instantly = new Instantly({ apiKey });
const campaigns = await instantly.campaigns.list({ limit: 10 });

console.log(campaigns);

Handle API errors

The SDK throws ResponseError when the API returns a non-successful response. Its response property is a standard Fetch API Response.

import { ResponseError } from '@instantlyai/sdk';

try {
  const campaigns = await instantly.campaigns.list({ limit: 10 });
  console.log(campaigns);
} catch (error) {
  if (error instanceof ResponseError) {
    console.error(error.response.status, await error.response.text());
  }

  throw error;
}

Overview

Getting started

Prerequisites

Handle API errors

Next steps

API reference

View on npm

​Prerequisites

​Handle API errors

​Next steps

API reference

View on npm

Prerequisites

Handle API errors

Next steps