> ## Documentation Index
> Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Use the official Instantly TypeScript SDK to build API v2 integrations.

The official [`@instantlyai/sdk`](https://www.npmjs.com/package/@instantlyai/sdk) package provides typed access to the Instantly API from TypeScript or JavaScript.

<Warning>
  The SDK is currently in beta. Its concise resource API may receive minor refinements before the stable `1.0.0` release.
</Warning>

## Why use the SDK?

<CardGroup cols={2}>
  <Card title="Typed resources" icon="file-code" iconType="solid">
    Use generated request and response types in your editor.
  </Card>

  <Card title="Concise methods" icon="code">
    Call resource methods such as `instantly.campaigns.list()` and `instantly.campaigns.create()`.
  </Card>

  <Card title="API coverage" icon="diagram-project">
    Access resource namespaces generated from the Instantly OpenAPI schema.
  </Card>

  <Card title="Flexible client" icon="sliders">
    Configure the base URL, headers, middleware, or a custom `fetch` implementation.
  </Card>
</CardGroup>

## Requirements

* Node.js 22 or later.
* An Instantly workspace with an [API v2 key](/getting-started/getting-started).

Keep your API key in a secure server-side environment. Do not include it in browser bundles or public source code.

## Next steps

<CardGroup cols={2}>
  <Card title="SDK quickstart" icon="rocket" href="/sdk/quickstart">
    Install the package and list your campaigns.
  </Card>

  <Card title="View on npm" icon="box" href="https://www.npmjs.com/package/@instantlyai/sdk">
    Check the package version, README, and release details.
  </Card>
</CardGroup>