Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nuntly.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

This guide provides an overview of the setup process and requirements for using the Nuntly SDK in your applications. Follow the steps below to get started quickly and efficiently.

​
Requirements

​
Install the SDK

Make sure you’ve installed the Nuntly SDK: 
pnpm add @nuntly/sdk

​
Initialize the SDK

To start using the Nuntly SDK, you need to initialize it with your API key. Here’s a basic example of how to do this in a TypeScript project: 
import { Nuntly } from '@nuntly/sdk';

const nuntly = new Nuntly({
  apiKey: 'YOUR_API_KEY_HERE',
});
Replace 'YOUR_API_KEY_HERE' with your actual API key from the Nuntly dashboard. For a better security practice, consider using environment variables to store your API key: 
import { Nuntly } from '@nuntly/sdk';
const nuntly = new Nuntly({
  apiKey: process.env.NUNTLY_API_KEY!,
});

​
Next Steps

For more detailed guides on using specific features of the Nuntly SDK, refer to the individual guides in this documentation. Happy coding!