Aidelly Docs
App Guides

Integrations

Connect Aidelly to your other tools — REST API, MCP server, CLI, Zapier, Make, n8n — with everything you need to authenticate and start sending requests.

What Integrations is for

You don't always want to work inside Aidelly's UI. Sometimes you want to:

  • Publish a post from a script you wrote
  • Trigger a draft from Zapier when a calendar event fires
  • Let Claude or ChatGPT operate Aidelly through MCP
  • Hook Aidelly into your existing CI/CD pipeline
  • Pull analytics into a custom dashboard

The Integrations page is where you find the right path, set up the credentials, and get linked to the deep docs for whichever route you pick.

This guide walks you through:

  1. Picking the right integration path
  2. Creating your first API key
  3. Setting up MCP for Claude / ChatGPT / Cursor
  4. Installing the CLI
  5. Connecting Zapier, Make, or n8n
  6. Managing and rotating credentials

Before you start

  • Know what you want to integrate (one external tool, a script, an AI assistant, an automation tool).
  • API access is included on every paid plan. Some advanced integrations require Scale or higher.

Step 1 — Open Integrations

  1. In the left sidebar, click 🔌 Integrations (or Account Settings → Integrations).
  2. The page shows cards for each integration path: REST API, MCP Server, CLI, Zapier, Make, n8n, Claude Skill.

Step 2 — Pick the right path

Use this decision tree:

  • I want to call the API from my own code → REST API (most flexible)
  • I want Claude / ChatGPT / Cursor to act in Aidelly directly → MCP Server
  • I want to script publishing from a terminal or CI → CLI
  • I want a no-code automation tied to an external trigger → Zapier / Make / n8n
  • I want to give Claude.ai a one-click way to use Aidelly → Claude Skill

All paths sit on top of the same REST API and use the same API keys.

Step 3 — Create your first API key

  1. On the Integrations page, click the API Keys card.
  2. Click + New API key in the top-right of the keys panel.
  3. Name the key for what it'll be used for (e.g. "n8n production", "publish script", "claude-mcp").
  4. Pick scopes — only check what the integration actually needs:
    • posts:write — create and schedule posts
    • posts:read — read posts
    • media:write — upload media
    • connections:read — list connected social accounts
    • inbox:read / inbox:write — read or respond to inbox items
    • approvals:read / approvals:write — manage the review queue
    • analytics:read — read performance data
    • ideas:read / ideas:write — manage the idea board
    • …and more (see the dialog for the full list)
  5. (Optional) Scope the key to a single workspace or brand.
  6. Click Create.
  7. Copy the key now — it's only shown once. Save it in your destination tool (1Password, Doppler, environment variable, etc.).

Step 4 — Test the API key

The fastest sanity check:

curl -H "Authorization: Bearer YOUR_KEY" \
  https://app.aidelly.ai/api/public/v1/usage

You should get a JSON envelope with your usage stats. If it returns 401, the key's wrong or the scopes don't include analytics:read (which usage requires).

Step 5 — Set up the MCP Server

For Claude Desktop, ChatGPT, Cursor, or any other MCP-compatible client:

  1. On the Integrations page, click the MCP Server card.
  2. Aidelly shows a one-line config block to paste into your client's MCP settings.
  3. The block includes your workspace's MCP URL and references your API key.
  4. Paste the block into the client.
  5. Restart the client.
  6. The Aidelly tools (aidelly_create_post, aidelly_list_accounts, aidelly_get_brand_settings_context, etc.) appear in the client's tool list.

Full setup guides per client:

Step 6 — Install the CLI

# Run without installing
npx @aidelly/cli --help

# Or install globally
npm install -g @aidelly/cli
aidelly --help

Authenticate:

aidelly auth login --api-key aidelly_live_xxx

Or set it via environment:

export AIDELLY_API_KEY=aidelly_live_xxx

Try a command:

aidelly post list --limit 5

Full docs at CLI overview.

Step 7 — Connect Zapier, Make, or n8n

For no-code automation tools:

  1. In the destination tool, search for the Aidelly app or use the Custom Webhook / HTTP connector.
  2. Authenticate with your API key from Step 3.
  3. Pick the trigger (in the external tool) and the action (in Aidelly: create post, list inbox items, etc.).
  4. Test the connection inside the tool.

Direct setup walkthroughs:

Step 8 — Manage and rotate keys

Keys live in the API Keys panel.

  1. Each row shows: key name, scopes, workspace scope, last-used time, created date.
  2. Rotate: create a new key with the same scopes, update your integration, then revoke the old one.
  3. Revoke: click the trash icon. Any tool using that key will get 401 immediately — make sure you've updated it first.

Security best practice: never paste an API key into Slack, email, or screenshots. Use a secret manager. Rotate every 90 days.

Common pitfalls

  • API key returns 401. Either it's wrong, revoked, or missing the required scope for the endpoint. Check the request's WWW-Authenticate header for a hint.
  • MCP tools don't show up in Claude. The config wasn't reloaded — fully restart Claude (not just close the conversation).
  • CLI says "command not found". You ran npm install -g but your shell's PATH doesn't include the npm global bin. Either use npx or fix your PATH.
  • Zapier shows "Aidelly app not found". Use the Webhooks by Zapier connector and call the API directly (Aidelly's native Zapier app is still in review).

What to do next