# Relaycast

> Relaycast is a unified social media API: publish, schedule and track posts across X, Instagram, Facebook, LinkedIn, TikTok, YouTube, Threads, Pinterest, Bluesky and Google Business Profile with one REST API. Every page below is available as Markdown.

## Docs: Get started

- [Getting Started](https://social-publish-kappa.vercel.app/docs.md): Publish your first post to one or more social networks with a single API request.
- [Authentication](https://social-publish-kappa.vercel.app/docs/authentication.md): Authenticate API requests with a project access key sent in the x-access-key header.
- [Core Concepts](https://social-publish-kappa.vercel.app/docs/core-concepts.md): Projects, social accounts, posts, targets, credits and how a post moves from request to published.

## Docs: Publishing

- [Social Accounts](https://social-publish-kappa.vercel.app/docs/social-accounts.md): Connect social accounts, find their IDs, and handle accounts that need reconnecting.
- [Posts](https://social-publish-kappa.vercel.app/docs/posts.md): Create a post for one or many accounts, customise it per account, and read back per-platform results.
- [Scheduling](https://social-publish-kappa.vercel.app/docs/scheduling.md): Schedule posts for a future time with scheduledFor, and understand time zones and delivery timing.
- [Media & Uploads](https://social-publish-kappa.vercel.app/docs/media.md): Attach images, videos and PDFs by public URL or from your project's media library.
- [Platform Options](https://social-publish-kappa.vercel.app/docs/platform-options.md): Set platform-specific fields such as titles, privacy levels and post types with targets[].options.
- [Idempotency & Retries](https://social-publish-kappa.vercel.app/docs/idempotency.md): Retry post creation safely with Idempotency-Key, and understand how publishing is retried.

## Docs: Live

- [Live Publish](https://social-publish-kappa.vercel.app/docs/live.md): Restream one live or recorded source (HLS, MP4, DASH, RTMP, RTSP, SRT or a media library video) to YouTube, Facebook, Twitch and any RTMP destination at the same time.

## Docs: Events

- [Notifications & Webhooks](https://social-publish-kappa.vercel.app/docs/notifications.md): Get an email or a signed webhook when posts are scheduled, published, partially fail or fail.

## Docs: Dashboard

- [Playground & Drafts](https://social-publish-kappa.vercel.app/docs/playground.md): Compose, validate and publish posts in the dashboard while the matching API request builds live.
- [Analytics](https://social-publish-kappa.vercel.app/docs/analytics.md): See posting activity across your project and load engagement numbers for individual posts.
- [Inbox & Comment Automation](https://social-publish-kappa.vercel.app/docs/inbox.md): Read and reply to Instagram and Facebook messages, and turn Instagram comments into automatic DMs.
- [OAuth Apps (BYOK)](https://social-publish-kappa.vercel.app/docs/oauth-apps.md): Connect accounts through your own platform developer apps so consent screens show your brand.
- [Social Groups](https://social-publish-kappa.vercel.app/docs/groups.md): Organise connected accounts into groups, for example by client or brand.
- [Collaborators & Projects](https://social-publish-kappa.vercel.app/docs/team.md): Invite teammates to a project, assign roles, and work across several projects.
- [Request Logs](https://social-publish-kappa.vercel.app/docs/logs.md): Inspect every authenticated API request your project made, with status, timing and errors.

## Docs: Account

- [Credits & Usage](https://social-publish-kappa.vercel.app/docs/credits.md): How publishing and analytics use credits, when credits are refunded, and how to track usage.
- [Rate Limits](https://social-publish-kappa.vercel.app/docs/limits.md): Per-key request limits, rate limit headers, and the size limits that apply to requests and posts.
- [Errors](https://social-publish-kappa.vercel.app/docs/errors.md): The error response format, every API error code, and the codes recorded on failed targets.

## Platforms

- [Platform Guides](https://social-publish-kappa.vercel.app/docs/platforms.md): What Relaycast can post to each social network, how each account connects, and where the per-platform rules live.
- [X (Twitter)](https://social-publish-kappa.vercel.app/docs/platforms/twitter.md): Post text, images, GIFs, video, threads, polls and quote posts to X through the X API v2.
- [Instagram](https://social-publish-kappa.vercel.app/docs/platforms/instagram.md): Publish feed posts, carousels, Reels and Stories to Instagram professional accounts.
- [Facebook](https://social-publish-kappa.vercel.app/docs/platforms/facebook.md): Publish text, link, photo and video posts, Reels and Stories to Facebook Pages.
- [LinkedIn](https://social-publish-kappa.vercel.app/docs/platforms/linkedin.md): Publish text, article links, images, video and PDF documents to LinkedIn profiles and Company Pages.
- [TikTok](https://social-publish-kappa.vercel.app/docs/platforms/tiktok.md): Publish videos and photo posts to TikTok with the Content Posting API, directly or as inbox drafts.
- [YouTube](https://social-publish-kappa.vercel.app/docs/platforms/youtube.md): Upload videos to a YouTube channel with title, visibility, tags, thumbnail and an automatic first comment.
- [Threads](https://social-publish-kappa.vercel.app/docs/platforms/threads.md): Publish text, image, video and carousel posts to Threads, with reply controls, topic tags, link cards and quotes.
- [Pinterest](https://social-publish-kappa.vercel.app/docs/platforms/pinterest.md): Create image, carousel and video Pins on your Pinterest boards with the Pinterest API v5.
- [Bluesky](https://social-publish-kappa.vercel.app/docs/platforms/bluesky.md): Post text, images, video, link cards and quote posts to Bluesky, connected with an app password.
- [Google Business Profile](https://social-publish-kappa.vercel.app/docs/platforms/google-business.md): Publish updates, events and offers with call-to-action buttons to Google Business Profile locations on Search and Maps.
- [Twitch](https://social-publish-kappa.vercel.app/docs/platforms/twitch.md): Go live on a Twitch channel with Live Publish. The title is set and the stream key is read automatically.

## API Reference

- [API Reference](https://social-publish-kappa.vercel.app/docs/api.md): Base URL, authentication, response format, errors, limits and the full list of Relaycast REST endpoints.

## API Reference: Accounts

- [List accounts](https://social-publish-kappa.vercel.app/docs/api/list-accounts.md): Return the social accounts connected to your project, with the IDs you use as post targets.
- [Create a connect link](https://social-publish-kappa.vercel.app/docs/api/create-connect-link.md): Create a one-time hosted link your user opens to connect a social account through OAuth, without a Relaycast login.
- [Get a connect link](https://social-publish-kappa.vercel.app/docs/api/get-connect-link.md): Check whether a connect link was used, and which accounts it connected.
- [Connect Bluesky](https://social-publish-kappa.vercel.app/docs/api/connect-bluesky.md): Connect or reconnect a Bluesky account with its handle and an app password.

## API Reference: Posts

- [Create a post](https://social-publish-kappa.vercel.app/docs/api/create-post.md): Publish now or schedule one post to up to 20 social accounts, with shared media and per-account text and options.
- [List posts](https://social-publish-kappa.vercel.app/docs/api/list-posts.md): Return your project's most recent posts, newest first, with their per-platform targets.
- [Get a post](https://social-publish-kappa.vercel.app/docs/api/get-post.md): Fetch one post with the status, platform post ID, URL and error of each target.

## API Reference: Live

- [Create a live stream](https://social-publish-kappa.vercel.app/docs/api/create-live.md): Start or schedule a Live Publish stream from a URL (HLS, MP4, DASH, RTMP, RTSP, SRT) or a media library video to several platforms.
- [List live streams](https://social-publish-kappa.vercel.app/docs/api/list-live.md): List the project's live streams, newest first.
- [Get a live stream](https://social-publish-kappa.vercel.app/docs/api/get-live.md): Fetch one live stream with its status, encoding stats and the status and watch URL of each destination.
- [Stop a live stream](https://social-publish-kappa.vercel.app/docs/api/stop-live.md): End a running live stream on every platform, or cancel a scheduled one.
- [Relaunch a live stream](https://social-publish-kappa.vercel.app/docs/api/relaunch-live.md): Start a new live stream now with the same source, settings and destinations as an earlier one.
- [Live usage](https://social-publish-kappa.vercel.app/docs/api/live-usage.md): Live minutes used and remaining this month for the project.

## API Reference: Events

- [Webhook events](https://social-publish-kappa.vercel.app/docs/api/webhook-events.md): Signed HTTP callbacks for post.scheduled, post.published, post.partial and post.failed, and how to verify them.

## API Reference: System

- [Health & readiness](https://social-publish-kappa.vercel.app/docs/api/health.md): Unauthenticated liveness and readiness endpoints for load balancers, uptime checks and orchestrators.

## AI & Integrations

- [AI & Integrations](https://social-publish-kappa.vercel.app/docs/ai.md): Use Relaycast from AI agents, coding assistants and no-code automation tools.
- [Agent Skill](https://social-publish-kappa.vercel.app/docs/ai/agent-skill.md): A ready-to-use SKILL.md that teaches coding agents how to publish with the Relaycast API.
- [Function Calling](https://social-publish-kappa.vercel.app/docs/ai/function-calling.md): Tool definitions and a minimal executor that let OpenAI or Claude models publish through Relaycast.
- [llms.txt & Markdown Docs](https://social-publish-kappa.vercel.app/docs/ai/llms-txt.md): Feed these docs to AI assistants with llms.txt, Markdown versions of every page, and one-click copy and open actions.
- [No-code (n8n, Make, Zapier)](https://social-publish-kappa.vercel.app/docs/ai/no-code.md): Publish from n8n, Make or Zapier workflows with a generic HTTP request step.