Chirpie Setup

Option A: Environment variable (recommended)

# .env or .env.local
CHIRPIE_API_KEY=chirpie_sk_YOUR_KEY

Option B: Direct initialization

import { ChirpieClient } from "@chirpie/sdk";

const chirpie = new ChirpieClient({
  apiKey: process.env.CHIRPIE_API_KEY!,
});

Security: Never hardcode API keys in source code. Always use environment variables.

Step 3: Connect Accounts

X/Twitter — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectAccount();
// Open URL in browser to authorize

Bluesky — Connect with an app password (generate at https://bsky.app/settings/app-passwords):

await chirpie.connectBlueskyAccount({
  platform: "bluesky",
  identifier: "yourhandle.bsky.social",
  app_password: "xxxx-xxxx-xxxx-xxxx",
});

Or via CLI:

chirpie accounts connect-bluesky --handle yourhandle.bsky.social --app-password xxxx-xxxx-xxxx-xxxx
# --handle is required, --app-password is optional (prompts securely if omitted)

LinkedIn — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectLinkedInAccount();
// Open URL in browser to authorize via LinkedIn OAuth

Or via CLI:

chirpie accounts connect-linkedin
# Opens browser for LinkedIn OAuth authorization

Threads — Connect via Meta OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectThreadsAccount();
// Open URL in browser to authorize via Meta OAuth

Or via CLI:

chirpie accounts connect-threads
# Opens browser for Meta OAuth authorization

Mastodon — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectMastodonAccount({
  platform: "mastodon",
  instance_url: "https://mastodon.social",
});
// Open URL in browser to authorize via Mastodon OAuth

Or via CLI:

chirpie accounts connect-mastodon --instance https://mastodon.social
# Opens browser for Mastodon OAuth authorization

Instagram — Connect via Instagram Login from the dashboard or API:

const { authorization_url } = await chirpie.connectInstagramAccount();
// Open URL in browser to authorize via Instagram Login

Or via CLI:

chirpie accounts connect-instagram
# Opens browser for Instagram Login OAuth authorization

Facebook — Connect a Facebook Page via Facebook Login from the dashboard or API:

const { authorization_url } = await chirpie.connectFacebookAccount();
// Open URL in browser to authorize via Facebook Login and select a Page

Or via CLI:

chirpie accounts connect-facebook
# Opens browser for Facebook Login OAuth authorization

Telegram — Connect with a bot token (create via @BotFather):

await chirpie.connectTelegramAccount({
  platform: "telegram",
  bot_token: "123456789:ABCdefGHIjklMNOpqrSTUvwxYZ",
  chat_id: "-1001234567890",
});

Or via CLI:

chirpie accounts connect-telegram --bot-token TOKEN --chat-id ID
# --bot-token and --chat-id are optional (prompts securely if omitted)

Reddit — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectRedditAccount();
// Open URL in browser to authorize via Reddit OAuth

Pinterest — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectPinterestAccount();
// Open URL in browser to authorize via Pinterest OAuth

TikTok — Connect via OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectTikTokAccount();
// Open URL in browser to authorize via TikTok OAuth

YouTube — Connect via Google OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectYouTubeAccount();
// Open URL in browser to authorize via Google OAuth

Google Business Profile — Connect via Google OAuth from the dashboard or API:

const { authorization_url } = await chirpie.connectGBPAccount();
// Open URL in browser to authorize via Google OAuth

Snapchat — Connect via OAuth from the dashboard or API (allowlist-only):

const { authorization_url } = await chirpie.connectSnapchatAccount();
// Open URL in browser to authorize via Snapchat OAuth

Step 4: Find Your Account ID

const accounts = await chirpie.listAccounts();
console.log(accounts);
// Each account has: id, platform, username, display_name, avatar_url
// Use the `id` field as your account_id for posting

Step 5: Send Your First Post

const post = await chirpie.createPost({
  account_id: "YOUR_ACCOUNT_ID",
  text: "Hello from Chirpie! 🐦",
});

console.log(`Posted! Status: ${post.status}`);

Alternative: CLI Setup

# Install globally
npm install -g chirpie

# Login via browser (creates API key automatically)
chirpie login

# Post (auto-selects account if you only have one)
chirpie post "Hello from the CLI!"

Alternative: MCP Setup

See chirpie-mcp skill for Claude/Cursor/AI agent configuration.

Common Pitfalls

1. API key format: Keys must start with chirpie_sk_. If you get 401 errors, check the prefix.
2. Account not active: If OAuth tokens expired or were revoked, is_active will be false. Re-authorize from the dashboard. For Bluesky, generate a new app password. For Telegram, verify bot token and chat ID.
3. Environment variable loading: In Next.js, server-side env vars don't need NEXT_PUBLIC_ prefix. Don't expose your API key to the browser.

Plan Limits