ChirpieDocs

Getting Started

Get up and running with Chirpie in under 2 minutes.

Chirpie is a social media API for AI agents and developers. Post to X/Twitter, Bluesky, LinkedIn, Threads, Mastodon, Instagram, Facebook, and Telegram via API, CLI, MCP, or SDK, with scheduling, analytics, and multi-platform support. Each network has its own page under Platforms: what Chirpie does there, how to connect, and examples.

Three ways to connect

All three use the same Chirpie account, the same connected social accounts and the same plan.

  1. From an AI app, with no code. Chirpie is listed in the Claude Connectors Directory: add it from there, sign in, and ask Claude to post. It also works in ChatGPT developer mode, in Meta Muse, and in Cursor or any MCP client, by adding https://chirpie.ai/mcp and signing in. See Use Chirpie with Claude and the MCP Server page.
  2. From your own code. The REST API at https://chirpie.ai/api/v1, the TypeScript SDK and the CLI, with an API key. The quick start below takes this route.
  3. From your own machine or workflow. The @chirpie/mcp package runs the MCP server locally over stdio, and the n8n node posts from a workflow.

Quick Start

1. Create an account

Sign up at chirpie.ai/auth/signup. You'll verify your email with a 6-digit code, then land in the onboarding flow.

2. Connect your social accounts

Follow the onboarding to connect your social accounts. X (Twitter), LinkedIn and Threads connect via OAuth. Instagram connects by signing in with Instagram or with Facebook, and Facebook Pages by signing in with Facebook. Mastodon connects via OAuth on your own instance. Bluesky uses an app password. Telegram uses a bot token. This authorizes Chirpie to post on your behalf. LinkedIn Pages, Pinterest, TikTok, YouTube, and Google Business Profile are coming soon.

3. Get your API key

Create an API key from the dashboard or during onboarding. Keys start with chirpie_sk_ and are shown once, so save it somewhere safe.

4. Send your first post

curl -X POST https://chirpie.ai/api/v1/posts \
  -H "Authorization: Bearer chirpie_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "YOUR_ACCOUNT_ID",
    "text": "Hello from Chirpie! 🐦"
  }'
import { ChirpieClient } from "@chirpie/sdk";

const chirpie = new ChirpieClient({ apiKey: "chirpie_sk_YOUR_KEY" });

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

console.log(post.id, post.status);
# First, authenticate
chirpie login

# Post (auto-selects account if you only have one)
chirpie post "Hello from Chirpie! 🐦"
{
  "tool": "chirpie_post",
  "arguments": {
    "account_id": "YOUR_ACCOUNT_ID",
    "text": "Hello from Chirpie! 🐦"
  }
}

Posting from the dashboard

You do not need an API key to send something quickly. The dashboard has a New post button on the Overview and the Schedule page, which opens the same posting flow this API exposes:

  • Pick one account or several, and write once for all of them.
  • Add another part to turn a post into a thread, up to 25 parts.
  • Attach media by public URL, or upload a file and attach its id. Every item takes alt text. See Media.
  • Post now, or switch to Schedule and pick a date and time in your own timezone. On the Schedule page, the "+" on a day queues a post for that day.
  • Not ready to send it? Save draft keeps it as it is, and the Drafts tab on the Schedule page brings it back to finish, schedule or post.

Before you send, the info button beside Post lists what each selected account will do with the draft: text over that platform's limit, media it cannot take, and whether a thread will publish as a reply chain or as separate posts. Anything the API would refuse is refused there first, so nothing is lost on a round trip.

Response Format

All API responses follow a consistent format:

// Success
{ "data": { ... } }

// Error
{ "error": { "code": "error_code", "message": "Human-readable description" } }

Base URL

https://chirpie.ai/api/v1

Next Steps

  • Authentication: API key setup and best practices
  • Posts API: Create, save as a draft, list, and delete posts
  • Threads API: Create multi-post threads
  • Media API: Upload images and videos, and describe them with alt text
  • Scheduling: Schedule posts for later
  • CLI Reference: Command-line interface
  • n8n: Post from an n8n workflow with the Chirpie community node
  • Skills: Teach AI coding agents to use Chirpie

On this page