Instantly Hello World
Overview
Minimal working example demonstrating core Instantly functionality.
Prerequisites
-
Completed instantly-install-auth setup
-
Valid API credentials configured
-
Development environment ready
Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client
import { InstantlyClient } from '@instantly/sdk';
const client = new InstantlyClient({ apiKey: process.env.INSTANTLY_API_KEY, });
Step 3: Make Your First API Call
async function main() { // Your first API call here }
main().catch(console.error);
Output
-
Working code file with Instantly client initialization
-
Successful API response confirming connection
-
Console output showing:
Success! Your Instantly connection is working.
Error Handling
Error Cause Solution
Import Error SDK not installed Verify with npm list or pip show
Auth Error Invalid credentials Check environment variable is set
Timeout Network issues Increase timeout or check connectivity
Rate Limit Too many requests Wait and retry with exponential backoff
Examples
TypeScript Example
import { InstantlyClient } from '@instantly/sdk';
const client = new InstantlyClient({ apiKey: process.env.INSTANTLY_API_KEY, });
async function main() { // Your first API call here }
main().catch(console.error);
Python Example
from instantly import InstantlyClient
client = InstantlyClient()
Your first API call here
Resources
-
Instantly Getting Started
-
Instantly API Reference
-
Instantly Examples
Next Steps
Proceed to instantly-local-dev-loop for development workflow setup.