Chirpie Sdk

Config file: ~/.chirpie/config.json (created by chirpie login)

All Methods

Posts

// Create a post (immediate or scheduled)
const post = await chirpie.createPost({
  account_id: "uuid",        // Required
  text: "Hello!",            // Required. Char limits: X 280 (25K Premium), Bluesky 300, LinkedIn 3K, Threads 500, Mastodon 500, Instagram 2,200, Facebook 63,206, Telegram 4,096, Reddit 40K, Pinterest 500, TikTok 2,200, YouTube 5K, Google Business 1,500, Snapchat 160
  media_urls: ["url"],       // Optional, limits vary by platform. Instagram/Pinterest/TikTok/YouTube/Snapchat REQUIRE media.
  schedule_at: "ISO8601",    // Optional, must be future
});

// List posts with filters
const posts = await chirpie.listPosts({
  status: "published",       // Optional
  account_id: "uuid",        // Optional
  limit: 20,                 // Optional, max 100
  offset: 0,                 // Optional
});

// Get a single post
const post = await chirpie.getPost("post-uuid");

// Delete a post (also deletes from platform if published, except TikTok)
const result = await chirpie.deletePost("post-uuid");

Threads

const thread = await chirpie.createThread({
  account_id: "uuid",
  posts: [
    { text: "First", media_urls: [] },
    { text: "Second" },
  ],
  schedule_at: "ISO8601",    // Optional
});

Accounts

// List all connected accounts (all 14 platforms)
const accounts = await chirpie.listAccounts();
// Each account: { id, platform, username, display_name, avatar_url, is_active }

// Connect X account (OAuth flow)
const { authorization_url } = await chirpie.connectAccount();

// Connect Bluesky account (app password)
await chirpie.connectBlueskyAccount({
  platform: "bluesky",
  identifier: "yourhandle.bsky.social",
  app_password: "xxxx-xxxx-xxxx-xxxx",
});

// Connect LinkedIn account (OAuth flow)
const { authorization_url } = await chirpie.connectLinkedInAccount();

// Connect Threads account (Meta OAuth flow)
const { authorization_url } = await chirpie.connectThreadsAccount();

// Connect Mastodon account (OAuth flow)
const { authorization_url } = await chirpie.connectMastodonAccount({
  platform: "mastodon",
  instance_url: "https://mastodon.social",
});

// Connect Instagram account (Instagram Login OAuth flow)
const { authorization_url } = await chirpie.connectInstagramAccount();

// Connect Facebook Page (Facebook Login OAuth flow)
const { authorization_url } = await chirpie.connectFacebookAccount();

// Connect Telegram bot (bot token auth)
await chirpie.connectTelegramAccount({
  platform: "telegram",
  bot_token: "TOKEN",
  chat_id: "CHAT_ID",
});

// Connect Reddit (OAuth), Pinterest, TikTok, YouTube, Google Business, Snapchat
const { authorization_url } = await chirpie.connectRedditAccount();
const { authorization_url } = await chirpie.connectPinterestAccount();
const { authorization_url } = await chirpie.connectTikTokAccount();
const { authorization_url } = await chirpie.connectYouTubeAccount();
const { authorization_url } = await chirpie.connectGBPAccount();
const { authorization_url } = await chirpie.connectSnapchatAccount();

API Keys

const { key, prefix, name } = await chirpie.createKey("My Bot");
const keys = await chirpie.listKeys();
await chirpie.revokeKey("key-uuid");

Analytics

const metrics = await chirpie.getPostAnalytics("post-uuid");
// { impressions, likes, retweets, replies, quotes, bookmarks, clicks, fetched_at }

Types

import type {
  ApiPost,                    // Post object (includes `platform` field)
  ApiThread,                  // Thread object returned from API
  ApiAccount,                 // Connected account (14 platform types, username, display_name, avatar_url)
  ApiAnalytics,               // Post metrics
  ApiKeyInfo,                 // API key metadata (prefix only)
  CreatePostInput,            // Input for createPost()
  CreateThreadInput,          // Input for createThread()
  ConnectBlueskyInput,        // Input for connectBlueskyAccount()
  ConnectLinkedInInput,       // Input for connectLinkedInAccount()
  ConnectThreadsInput,        // Input for connectThreadsAccount()
  ConnectMastodonInput,       // Input for connectMastodonAccount()
  ConnectInstagramInput,      // Input for connectInstagramAccount()
  ConnectFacebookInput,       // Input for connectFacebookAccount()
  ConnectTelegramInput,       // Input for connectTelegramAccount()
  ConnectRedditInput,         // Input for connectRedditAccount()
  ConnectPinterestInput,      // Input for connectPinterestAccount()
  ConnectTikTokInput,         // Input for connectTikTokAccount()
  ConnectYouTubeInput,        // Input for connectYouTubeAccount()
  ConnectGBPInput,            // Input for connectGBPAccount()
  ConnectSnapchatInput,       // Input for connectSnapchatAccount()
  ListPostsOptions,           // Options for listPosts()
} from "@chirpie/sdk";

Error Handling

import { ChirpieApiError, ChirpieError } from "@chirpie/sdk";

try {
  await chirpie.createPost({ ... });
} catch (err) {
  if (err instanceof ChirpieApiError) {
    console.error(err.code);     // "rate_limited", "not_found", etc.
    console.error(err.message);  // Human-readable description
    console.error(err.status);   // HTTP status code (400, 401, 404, 429, 502)
  } else if (err instanceof ChirpieError) {
    console.error(err.message);  // Network or config error
  }
}

Config Utilities

import { getConfig, saveConfig, deleteConfig, requireConfig } from "@chirpie/sdk";

// Read config (returns null if not found)
const config = getConfig();

// Save config (creates ~/.chirpie/config.json with 0600 permissions)
saveConfig("chirpie_sk_...", "https://chirpie.ai");

// Delete config
deleteConfig();

// Read config or throw (for scripts that require auth)
const config = requireConfig();