SWAYDSTUDIO/Help Center
All GuidesPricingStudio Sign In
Publishing & API3 min read

Help Center: Multi-Platform Publishing, Commercial REST API & FastMCP Integration

Help Center: Multi-Platform Publishing, Commercial REST API & FastMCP Integration

Welcome to the Swayd Publishing Hub & Developer Platform. This guide explains how to distribute your rendered editorial carousels to social networks via Swayd Social Publisher, provision developer API keys, and connect Swayd directly into Claude Desktop, Cursor, and custom automation scripts via the Model Context Protocol (MCP).

1. Multi-Platform Social Publishing & Scheduling

Once a carousel is exported into 4:5, 9:16, 2:3, and LinkedIn PDF Retina formats on Swayd CDN, you can dispatch it to multiple social networks simultaneously:

Step-by-Step Walkthrough

  • Navigate to the Publishing Desk: Go to /dashboard/publish.
  • Select Carousel Project: Pick any project in EDITOR_READY or STUDIO_READY status with exported assets.
  • Choose Target Channels:
  • LinkedIn: Dispatches the multi-page PDF document (linkedin_pdf).
  • Instagram: Dispatches the 4:5 vertical multi-image carousel (ig_4_5).
  • TikTok / Stories: Dispatches the framed 9:16 vertical slides (tiktok_9_16).
  • Pinterest: Dispatches the framed 2:3 pin deck (pinterest_2_3).
  • Edit Post Caption: Refine the generated direct-response headline, hook, body bullets, and hashtags.
  • Publish Now or Schedule: Choose immediate broadcast or pick a target publish time.
  • Live Synchronization: Swayd automatically records the social post ID and syncs engagement metrics (views, saves, likes, shares) every day at 04:00 UTC.

    • 2. Commercial Public REST API (/api/v1/...)

    Developers and agencies can invoke Swayd programmatically to mine unseen buyer pain points, synthesize brand ideas, generate full carousels, or edit slide bounding boxes.

    Authentication

    Authenticate every request by providing the header:

    http
    X-Swayd-API-Key: swayd_live_YOUR_SECRET_KEY

    Endpoints & Credit Consumption

  • POST /api/v1/signals/mine (signals:read): Extracts 45 fresh, unconsumed buyer complaints from Layer 1/2 Signal Lake (2 generation credits).
  • POST /api/v1/ideas/generate (ideas:write): Synthesizes 15 grounded concepts through Brand-DNA Prism with semantic deduplication (2 generation credits).
  • POST /api/v1/carousels/generate (carousels:write): Generates a full editorial carousel via Swayd Editorial Director (slide_count generation credits).
  • POST /api/v1/slides/{slide_id}/edit (slides:edit): Runs a pixel-restoration bounding-box edit via Swayd Optical Studio (1 edit credit).
  • GET /api/v1/layouts/archetypes (signals:read): Lists available layout archetypes (0 credits).

    • 3. FastMCP Server Integration (Claude Desktop & Cursor)

    Swayd exposes a Model Context Protocol server mounted at /mcp with SSE streaming at /mcp/sse.

    Claude Desktop Configuration (claude_desktop_config.json)

    Add Swayd to your Claude Desktop config:

    json
    {
  "mcpServers": {
    "swayd": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-sse", "https://tryswayd.com/mcp/sse"],
      "env": {
        "SWAYD_API_KEY": "swayd_live_YOUR_API_KEY"
      }
    }
  }
}

    Cursor / Windsurf Configuration

    In Cursor Settings -> Features -> MCP Servers:

  • Name: Swayd Editorial Content & Carousel Engine
  • Type: sse
  • URL: https://tryswayd.com/mcp/sse
  • Headers: {"X-Swayd-API-Key": "swayd_live_YOUR_API_KEY"}

    • Frequently Asked Questions (FAQ)

    1. Where do I get my Swayd API Key?

    Go to /dashboard/api-keys and click "Generate New Live Key". Choose your authorized scopes and copy the key immediately. For security, Swayd stores only an irreversible SHA-256 hash in PostgreSQL; the full plaintext key will never be displayed again.

    2. Can I use the same API key for both REST endpoints and MCP?

    Yes. Keys provisioned with the standard scopes (signals:read, ideas:write, carousels:write, slides:edit, mcp:tools) authenticate both the /api/v1/... REST API and the /mcp FastMCP server.

    3. How are credits debited when using the API or MCP?

    Credits are debited atomically from your workspace before downstream operations are executed. If your workspace runs out of generation or edit credits, the API returns HTTP 402 Payment Required.

    4. What happens if a social network is down or my account is disconnected?

    If a social publishing channel rejects the broadcast, Swayd writes the real error message to carousel_projects.error_message, marks the project status as FAILED, and alerts you immediately in the UI. No silent failures or fake success statuses are ever produced.

    5. Can I revoke an API key if it gets leaked?

    Yes. Under /dashboard/api-keys, click the trash icon next to any active key to revoke it instantly. Revocation takes effect immediately across all REST and MCP invocations.

    Have additional questions?

    Reach out to our creative support team at support@tryswayd.com.

    Return to Help Center