# SocialAPI > SocialAPI is a unified social media API and MCP server: one REST API to read and answer comments, DMs, reviews, and mentions, run Automations, and publish posts across the major social platforms. Support differs per platform. > ## Agent Instructions > Base URL: https://api.social-api.ai/v1. Send your API key in the Authorization header: Authorization: Bearer . > Every error response from /v1 is JSON: { "error": { "code", "message", "meta" (optional) }, "request_id" }. Branch on error.code; use error.message only for logs. > A 429 response carries a Retry-After header, in seconds, when the limit has a known wait. Authenticated responses can carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset for the per-minute request budget your SocialAPI account shares across every API key (see /guides/rate-limits). > Paginated list endpoints return next_cursor, at the top level or inside pagination (see /guides/pagination). Pass it as the cursor query parameter to get the next page. An absent or empty next_cursor means you have the last page. > Treat every ID as an opaque string: do not parse it or assume a format. > Support differs by platform and by operation. Check /platforms/overview before assuming an operation works on a platform. An unsupported operation returns 501 with error.code resource.not_supported. - [SocialAPI](https://docs.social-api.ai/index.md): Read and answer comments, DMs, mentions, and reviews, publish posts, and automate replies across social platforms with one REST API and MCP server. - [Quickstart](https://docs.social-api.ai/quickstart.md): Get an API key, connect an Instagram account, read and reply to a comment, and publish a post with the SocialAPI REST API in about 10 minutes. - [Core concepts](https://docs.social-api.ai/guides/concepts.md): Learn the five objects of the SocialAPI REST API (brand, account, post, interaction, capability) and how they relate before you build. - [Use cases](https://docs.social-api.ai/guides/use-cases.md): See how developers and AI agents use the SocialAPI REST API and MCP server for an inbox, comment-to-DM Automations, publishing, scheduling, and agents. - [Connect a social account](https://docs.social-api.ai/guides/connect-accounts.md): Connect Instagram, Facebook, TikTok, YouTube, LinkedIn, X, and more to SocialAPI, choose a location, reconnect, and disconnect accounts. - [Account permissions](https://docs.social-api.ai/guides/permissions.md): Connect an account with only the permissions your integration uses, so the person connecting it is never asked for more. - [Platform apps](https://docs.social-api.ai/guides/platform-credentials.md): See which app connects each platform to SocialAPI: SocialAPI's own apps for most platforms, and your own X app, Telegram bot, or Bluesky app password. - [Unified inbox](https://docs.social-api.ai/guides/inbox.md): Read and answer comments, direct messages, reviews, and mentions from every connected platform through one inbox API with one set of IDs and cursors. - [Comments](https://docs.social-api.ai/guides/comments.md): List posts with comments, read comments and replies, reply publicly or privately, hide, delete, and like comments across platforms through one API. - [Direct messages](https://docs.social-api.ai/guides/direct-messages.md): List DM conversations, read messages, send text, attachments, and buttons, react to messages, and respect each platform's messaging window through one API. - [Reviews](https://docs.social-api.ai/guides/reviews.md): List the reviews of your connected business locations, read their rating summaries, and post the business's public reply through one reviews API. - [Mentions](https://docs.social-api.ai/guides/mentions.md): List the posts and comments that mention or tag a connected account, and reply to a mention as a public comment, through one mentions API. - [Automations](https://docs.social-api.ai/guides/automations.md): Answer matching comments and DMs on Instagram and Facebook with rules you set once through the API, with no code running on your side. - [Publish a post](https://docs.social-api.ai/guides/publishing.md): Publish, validate, edit, and import posts to Instagram, Facebook, TikTok, YouTube, and more with one POST /v1/posts request and per-platform delivery status. - [Schedule posts](https://docs.social-api.ai/guides/scheduling.md): Schedule a post to publish at a future time on every platform, edit or cancel it, and learn how posting caps and failures affect a scheduled post. - [Upload media](https://docs.social-api.ai/guides/media.md): Upload images and videos to your SocialAPI media library with one request or a presigned URL, or attach a public URL or platform attachment ID to a post. - [Track post delivery](https://docs.social-api.ai/guides/delivery.md): Read the HTTP status, post status, and per-target results of a published post to see what reached each platform, and learn how deleting a post works. - [Analytics](https://docs.social-api.ai/guides/analytics.md): Read daily history for accounts, brands, and posts, fetch live post metrics from each platform, and refresh an account's posts with one request. - [Webhooks](https://docs.social-api.ai/guides/webhooks.md): Register an HTTPS endpoint, verify each request signature, and handle retries to receive real-time comments, DMs, mentions, reviews, and post events. - [Webhook events](https://docs.social-api.ai/guides/webhook-events.md): Every webhook event SocialAPI sends: when it fires, which platforms emit it, and its payload and fields, across posts, inbox, and accounts. - [Authentication](https://docs.social-api.ai/guides/authentication.md): Authenticate SocialAPI requests with an API key or an OAuth 2.1 access token, and create, list, rotate, and revoke API keys. - [Scoped API keys](https://docs.social-api.ai/guides/scoped-keys.md): Restrict a SocialAPI key to specific scopes and brands for least-privilege automations, AI agents, and agency client isolation. - [Errors](https://docs.social-api.ai/guides/errors.md): Look up every error code the SocialAPI REST API and MCP server return, with its HTTP status, what triggers it, and how to handle it. - [Rate limits](https://docs.social-api.ai/guides/rate-limits.md): Stay within SocialAPI's request rate limit, posting velocity caps, and each platform's own limits, and handle HTTP 429 with Retry-After. - [Plans and usage](https://docs.social-api.ai/guides/plans.md): Compare SocialAPI plans, see what costs a post or interaction credit, read your usage from the API, and learn what happens when a payment fails. - [Pagination](https://docs.social-api.ai/guides/pagination.md): Page through SocialAPI list endpoints with limit and cursor, and look up the default page size, maximum, and next-cursor field of every paginated endpoint. - [IDs](https://docs.social-api.ai/guides/ids.md): Look up the ID format of every SocialAPI object, learn which IDs stay stable, and which create requests are not idempotent. - [Request IDs](https://docs.social-api.ai/guides/debugging.md): Read the X-Request-ID header and the request_id error field to identify a SocialAPI call, send your own request ID, and report a failed call. - [Announcements](https://docs.social-api.ai/guides/announcements.md): Read SocialAPI maintenance windows, incidents, product updates, and breaking changes through the API, and mark each one as seen. - [Supported platforms](https://docs.social-api.ai/platforms/overview.md): Which operations each SocialAPI platform supports for the inbox, Automations, publishing, analytics, and webhook events, in one matrix per feature area. - [Instagram API](https://docs.social-api.ai/platforms/instagram.md): Connect Instagram Business and Creator accounts to publish, moderate comments, send DMs, and read mentions, stories, and insights through one API. - [Instagram publishing](https://docs.social-api.ai/platforms/instagram/publishing.md): Publish image, video, Reel, Story, and carousel posts to Instagram through SocialAPI, with platform-specific fields, limits, and error recovery. - [Facebook API](https://docs.social-api.ai/platforms/facebook.md): Connect Facebook Pages to publish posts and Reels, moderate comments, send private replies and Messenger DMs, and read mentions through one API. - [Facebook publishing](https://docs.social-api.ai/platforms/facebook/publishing.md): Publish text, link, photo, video, album, Reel, and Story posts to Facebook Pages through SocialAPI, with platform fields, limits, and error recovery. - [Threads API](https://docs.social-api.ai/platforms/threads.md): Connect Threads accounts to publish text, image, video, and carousel posts, read and moderate replies, and read mentions and insights through one API. - [Threads publishing](https://docs.social-api.ai/platforms/threads/publishing.md): Publish text, image, video, and carousel posts to Threads accounts through SocialAPI, with platform-specific fields, limits, and error recovery. - [Google Business Profile API](https://docs.social-api.ai/platforms/google.md): Connect Google Business Profile locations to publish local posts, manage reviews, update the profile, and read performance metrics and search keywords. - [Google Business Profile publishing](https://docs.social-api.ai/platforms/google/publishing.md): Publish, schedule, and delete Google Business Profile local posts (updates, events, offers, alerts) with text, one image, and a call-to-action button. - [Google Business Profile locations](https://docs.social-api.ai/platforms/google/locations.md): Read, assign, and update Google Business Profile locations, and manage the photos and videos on a location's public profile. - [Google Business Profile reviews](https://docs.social-api.ai/platforms/google/reviews.md): List the Google reviews on a Business Profile location, reply to them, and handle Google's moderation of replies and the review webhook events. - [TikTok API](https://docs.social-api.ai/platforms/tiktok.md): Connect TikTok accounts to publish videos and photo carousels, read and moderate comments, list mentions, and read profile counts and post metrics. - [TikTok publishing](https://docs.social-api.ai/platforms/tiktok/publishing.md): Full reference for publishing TikTok videos and photo carousels via SocialAPI, including privacy rules, drafts, metrics, and the publishing status. - [LinkedIn API](https://docs.social-api.ai/platforms/linkedin.md): Connect a LinkedIn member profile or company Page to publish posts, and on a Page read and answer comments and mentions. - [LinkedIn publishing](https://docs.social-api.ai/platforms/linkedin/publishing.md): Full reference for publishing LinkedIn posts via SocialAPI, including images, videos, multi-image posts, link posts, text formatting, and visibility. - [X / Twitter API](https://docs.social-api.ai/platforms/twitter.md): Connect X accounts through your own X app to publish posts and threads with media, read and moderate replies, send DMs, and read mentions. - [X / Twitter publishing](https://docs.social-api.ai/platforms/twitter/publishing.md): Full reference for publishing X posts via SocialAPI, including images, video, GIFs, threads, replies, reply settings, and platform-specific parameters. - [Use your own X app](https://docs.social-api.ai/platforms/twitter/own-app.md): Create an X developer app, save its OAuth 2.0 credentials in SocialAPI, and connect X accounts, with the exact settings and fixes for common errors. - [Telegram API](https://docs.social-api.ai/platforms/telegram.md): Connect a Telegram bot with its BotFather token, then read and answer the direct messages people send to your bot through one REST API. - [WhatsApp](https://docs.social-api.ai/platforms/whatsapp.md): Connect a WhatsApp Business phone number to receive and reply to direct messages through SocialAPI. - [Zalo API](https://docs.social-api.ai/platforms/zalo.md): Connect a Zalo Official Account to read and answer direct messages and to publish, schedule, and delete articles through one API, with no Zalo app to register. - [Zalo publishing](https://docs.social-api.ai/platforms/zalo/publishing.md): Publish, schedule, and delete text articles on a Zalo Official Account with SocialAPI, including asynchronous creation and title rules. - [Bluesky API](https://docs.social-api.ai/platforms/bluesky.md): Connect a Bluesky account with an app password to publish posts, read and reply to comments and mentions, and send direct messages through one API. - [Bluesky publishing](https://docs.social-api.ai/platforms/bluesky/publishing.md): Publish and schedule Bluesky posts with text and up to 4 images through SocialAPI, with media limits, link and hashtag handling, and delete. - [Pinterest API](https://docs.social-api.ai/platforms/pinterest.md): Connect Pinterest accounts to publish Pins to boards, manage boards, list Pins, and read profile counts through one API. - [Pinterest publishing](https://docs.social-api.ai/platforms/pinterest/publishing.md): Full reference for publishing Pins via SocialAPI, including the board target, Pin title, description, link, alt text, scheduling, and quirks. - [Pinterest boards](https://docs.social-api.ai/platforms/pinterest/boards.md): List, create, rename, and delete Pinterest boards through SocialAPI, and use a board ID to publish Pins to it. - [YouTube API](https://docs.social-api.ai/platforms/youtube.md): Connect YouTube channels to publish and edit videos, read and moderate comments, and read channel stats through one API. - [YouTube publishing](https://docs.social-api.ai/platforms/youtube/publishing.md): Publish, schedule, edit, and delete YouTube videos with title, description, tags, visibility, a first comment, and a playlist, and read their metrics. - [Trustpilot API](https://docs.social-api.ai/platforms/trustpilot.md): Trustpilot is not available in SocialAPI: you cannot connect a Trustpilot account. Google Business Profile reads and replies to reviews. - [SocialAPI MCP server](https://docs.social-api.ai/integrations/overview.md): Connect Claude, ChatGPT, Cursor, and other AI clients to the SocialAPI MCP server to read comments, reply, send DMs, and publish posts. - [Claude](https://docs.social-api.ai/integrations/claude.md): Connect SocialAPI to Claude on claude.ai, Claude Desktop, Claude Code, and mobile to manage comments, DMs, and posts in plain language. - [ChatGPT](https://docs.social-api.ai/integrations/chatgpt.md): Connect SocialAPI to ChatGPT on web, desktop, and mobile with a custom connector to manage comments, DMs, and posts in plain language. - [Mistral / Le Chat](https://docs.social-api.ai/integrations/mistral.md): Connect SocialAPI to Le Chat from Mistral on web and mobile with a custom MCP connector to manage comments, DMs, and posts. - [Cursor](https://docs.social-api.ai/integrations/cursor.md): Connect SocialAPI to Cursor with a config file or the Settings UI so Agent mode can manage comments, DMs, and posts in plain language. - [VS Code + GitHub Copilot](https://docs.social-api.ai/integrations/vscode.md): Connect SocialAPI to VS Code with GitHub Copilot using a config file or the Command Palette so Agent mode can manage comments, DMs, and posts. - [Codex](https://docs.social-api.ai/integrations/codex.md): Connect SocialAPI to OpenAI Codex (CLI, IDE extension, and ChatGPT desktop app) with one entry in ~/.codex/config.toml. - [Hermes Agent](https://docs.social-api.ai/integrations/hermes.md): Connect SocialAPI to Nous Research's Hermes Agent with one mcp_servers entry, then publish and reply from any chat Hermes is connected to. - [OpenClaw](https://docs.social-api.ai/integrations/openclaw.md): Connect SocialAPI to OpenClaw with one openclaw mcp add, so the agent behind every routed channel can publish and reply. - [Custom MCP clients](https://docs.social-api.ai/integrations/custom.md): Connect any MCP client to the SocialAPI MCP server with an API key for headless agents, server-side scripts, and CI jobs. - [OAuth for MCP clients](https://docs.social-api.ai/integrations/oauth.md): Authenticate an MCP client or your own app against SocialAPI with OAuth 2.1, PKCE, and dynamic client registration, then call the API for a user. - [MCP tools reference](https://docs.social-api.ai/integrations/tools.md): Look up every SocialAPI MCP tool by area: what each tool does and the REST endpoint that runs the same operation. - [Changelog](https://docs.social-api.ai/changelog.md): Changes to the SocialAPI API and documentation, newest first. Subscribe to the RSS feed to follow new entries. - [API reference](https://docs.social-api.ai/api-reference/introduction.md): Look up the SocialAPI REST API base URL, authentication, request and response format, and error envelope before you open an endpoint. - [List connected accounts](https://docs.social-api.ai/api-reference/accounts/list-connected-accounts.md): Returns all active social media accounts connected to the authenticated API key's workspace. - [Connect a social account](https://docs.social-api.ai/api-reference/accounts/connect-a-social-account.md): Initiates account connection. For OAuth2 platforms returns an auth_url to redirect the user to. For apikey/credentials platforms stores the credentials immediately and returns account_id. For WhatsApp, open auth_url to run Meta's signup. When the WhatsApp Business account holds several numbers, the… - [Get a pending Google Profile selection](https://docs.social-api.ai/api-reference/accounts/get-a-pending-google-profile-selection.md): Returns the candidate Google Business Profiles for a pending connection created when a Google login manages more than one Profile. Choose one with the select endpoint. - [Select a Google Business Profile or Facebook Pages to connect](https://docs.social-api.ai/api-reference/accounts/select-a-google-business-profile-or-facebook-pages-to-connect.md): Promotes a pending connection into a connected account. For Google, pass platform_account_id to choose exactly one candidate Profile. For Facebook, pass page_ids with the subset of candidate Pages to assign to the brand. First selection wins; the pending connection is then consumed. - [Disconnect a social account](https://docs.social-api.ai/api-reference/accounts/disconnect-a-social-account.md): Disconnects a connected account. It will no longer appear in the accounts list and all API calls using this account will return 404. - [Update an account's permissions](https://docs.social-api.ai/api-reference/accounts/update-an-accounts-permissions.md): Replaces the permissions of a connected account. Send null for every permission, including ones added later. Removing a permission takes effect at once and immediately deletes the comments, messages, analytics and posts not published through SocialAPI that it covers, and adding the permission back d… - [List Pinterest boards](https://docs.social-api.ai/api-reference/accounts/list-pinterest-boards.md): Returns the boards for a connected Pinterest account. - [Create Pinterest board](https://docs.social-api.ai/api-reference/accounts/create-pinterest-board.md): Creates a board on Pinterest and returns it. - [Delete Pinterest board](https://docs.social-api.ai/api-reference/accounts/delete-pinterest-board.md): Deletes the board on Pinterest along with every pin saved to it. This cannot be undone. - [Update Pinterest board](https://docs.social-api.ai/api-reference/accounts/update-pinterest-board.md): Update a board. Privacy accepts only PUBLIC or SECRET. - [Get creator info for publishing](https://docs.social-api.ai/api-reference/accounts/get-creator-info-for-publishing.md): Returns platform-specific creator settings needed before publishing (privacy levels, interaction toggles, posting availability). Currently supported for TikTok only; other platforms return 501. - [List account pages](https://docs.social-api.ai/api-reference/accounts/list-account-pages.md): Returns pages (e.g. Facebook Pages) associated with a connected account. - [Update account page](https://docs.social-api.ai/api-reference/accounts/update-account-page.md): Update a page's is_default or is_active status. - [Re-sync a connected account's posts](https://docs.social-api.ai/api-reference/accounts/re-sync-a-connected-accounts-posts.md): Refreshes one connected account's posts: new posts appear, engagement counts update, and Instagram and Facebook media links in platform_media are renewed. Instagram covers up to the 500 most recent posts, Facebook up to the 500 most recent per Page; other platforms cover up to the 25 most recent. Av… - [Exchange OAuth code](https://docs.social-api.ai/api-reference/accounts/exchange-oauth-code.md): Exchanges an OAuth authorization code for a connected social account. Use this when you handle the OAuth callback on your own server (proxy flow). For a single account the response is a flat ConnectAccountResponse (HTTP 201). When a single OAuth flow connects multiple accounts (e.g. Facebook Pages)… - [List Pinterest pins](https://docs.social-api.ai/api-reference/accounts/list-pinterest-pins.md): Returns the connected Pinterest account's pins. - [Get Pinterest account summary](https://docs.social-api.ai/api-reference/accounts/get-pinterest-account-summary.md): Returns the connected Pinterest account's public profile counts: followers, pins, boards, and monthly views. - [Get account analytics history](https://docs.social-api.ai/api-reference/analytics/get-account-analytics-history.md): Returns daily history for a connected account: follower levels, reach, and the other metrics the platform publishes. For the account's current figures, use the live insights routes instead. Each series names its metric kind (gauge for a level you may diff, flow for a per-day count you may sum) and t… - [Get brand analytics history](https://docs.social-api.ai/api-reference/analytics/get-brand-analytics-history.md): Returns daily history for every account and page in a brand, summed per metric per day. A brand total always reflects the accounts the brand holds right now. Read subjects_counted before drawing a chart. A brand whose accounts did not all report on a given day produces a lower sum for that day, and… - [Get post analytics history](https://docs.social-api.ai/api-reference/analytics/get-post-analytics-history.md): Returns daily history for a published post: how its engagement counters accrued, one point per day. This is the history route. For the post's current figures, use GET /v1/posts/{pid}/metrics instead. History does not extend back before the post was first tracked, so an older post may have no earlier… - [Create analytics export](https://docs.social-api.ai/api-reference/exports/create-analytics-export.md): Enqueue an async analytics export job for a connected account. Subject to plan limits (exports per month, cooldown hours, concurrent export cap). For some TikTok accounts, include_transcript and include_vision are refused with 400 account.export_enrichment_not_supported; export again without them. - [List analytics exports](https://docs.social-api.ai/api-reference/exports/list-analytics-exports.md): Returns the 50 most recent export jobs for the authenticated user. Optionally filter by status. - [Get export status and result](https://docs.social-api.ai/api-reference/exports/get-export-status-and-result.md): Returns the current status, progress, result download URL (presigned Excel), and report URL for an export job. - [Get export videos](https://docs.social-api.ai/api-reference/exports/get-export-videos.md): Returns the video data for a completed export, including metrics and optional AI-enriched fields (transcript, vision summary). - [Get platform usage limits](https://docs.social-api.ai/api-reference/usage/get-platform-usage-limits.md): Returns platform-specific quota data for a connected account as a key/value map where values are remaining counts. Keys are platform-defined - for example Instagram returns `posts_remaining`. An empty object is returned for platforms without usage limits. - [Get resource usage for the current billing period](https://docs.social-api.ai/api-reference/usage/get-resource-usage-for-the-current-billing-period.md): Returns brands, posts, and interactions consumed during the current billing period alongside the plan limits. -1 means unlimited (all paid plans). Period boundaries follow your subscription cycle, or a rolling 30-day window on the free plan. - [List brand mentions](https://docs.social-api.ai/api-reference/mentions/list-brand-mentions.md): Fetches posts where your brand account was mentioned or tagged. Results are sorted newest-first. Returns 501 for platforms that do not support mention tracking. On Instagram this returns only media your account was tagged in: @mentions written inside a post caption or inside a comment are never incl… - [Reply to a mention](https://docs.social-api.ai/api-reference/mentions/reply-to-a-mention.md): Replies, as a public comment, to a mention of the connected account, including on a third-party post where the normal comment-reply endpoint is not permitted. Provide media_id (the media/post the mention is on); set comment_id only when the mention was in a comment (omit it to reply to a mention in… - [List active announcements](https://docs.social-api.ai/api-reference/announcements/list-active-announcements.md): Returns service announcements that are currently visible, newest first. Each item carries a `seen` flag for the calling user. `window_start` and `window_end` describe the announced maintenance window and are absent for non-maintenance announcements. Free operation, consumes no credits. - [Mark an announcement as seen](https://docs.social-api.ai/api-reference/announcements/mark-an-announcement-as-seen.md): Records that the calling user has seen an announcement, so it is not shown again. Idempotent: repeat calls succeed without changing anything. Free operation, consumes no credits. - [List Automations](https://docs.social-api.ai/api-reference/automations/list-automations.md): Lists your Automations, newest first. Filter to one account with account_id. - [Create an Automation](https://docs.social-api.ai/api-reference/automations/create-an-automation.md): Creates an Automation on an Instagram or Facebook account. When a comment or DM on the account matches its filters, its actions are carried out within seconds, with no code on your side. Each action costs what the same API call costs: reply_comment and send_dm cost 1 credit, private_reply and hide_c… - [Get an Automation](https://docs.social-api.ai/api-reference/automations/get-an-automation.md): Returns one Automation with its fired, sent and failed counts. - [Delete an Automation](https://docs.social-api.ai/api-reference/automations/delete-an-automation.md): Deletes an Automation and its run history. Buttons it already sent stop doing anything. - [Update an Automation](https://docs.social-api.ai/api-reference/automations/update-an-automation.md): Updates the fields you send and keeps the rest. Set status to paused to stop the Automation and to active to resume it. steps replaces the whole list. Changed steps or post_ids must meet the same rules as creation. Renaming or pausing needs only automations:write; resuming, or changing steps, post_i… - [List an Automation's runs](https://docs.social-api.ai/api-reference/automations/list-an-automations-runs.md): Lists the Automation's runs from the last 30 days, newest first, with the outcome of each action. A failed action carries the error code the same API call would have returned. - [List plans](https://docs.social-api.ai/api-reference/billing/list-plans.md): Returns every subscription tier with prices and resource limits, ordered from cheapest to most expensive. Each tier is priced in USD and in EUR. -1 means unlimited for limits and custom pricing for prices. - [List brands](https://docs.social-api.ai/api-reference/brands/list-brands.md): Returns all brands for the authenticated user with their connected account counts. - [Create a brand](https://docs.social-api.ai/api-reference/brands/create-a-brand.md): Creates a new brand for grouping connected social accounts. Each brand can have one account per platform. - [Delete a brand](https://docs.social-api.ai/api-reference/brands/delete-a-brand.md): Deletes a brand and disconnects all its connected accounts. - [Update a brand](https://docs.social-api.ai/api-reference/brands/update-a-brand.md): Renames a brand. - [List developer events](https://docs.social-api.ai/api-reference/events/list-developer-events.md): Returns a paginated, filtered slice of the unified event log. Events cover post lifecycle, inbox activity, account changes, and webhook deliveries. Retention varies by plan tier; the response includes the user's current retention window. - [Event summary counts](https://docs.social-api.ai/api-reference/events/event-summary-counts.md): Returns aggregated event counts for the requested window: totals, failure counts, breakdowns by category and error category, plus inbox-specific breakdown. Useful for dashboard summary cards. - [Send feedback](https://docs.social-api.ai/api-reference/feedback/send-feedback.md): Submit feedback (bug report, feature request, or general comment). Routed to the SocialAPI team. - [List commented posts](https://docs.social-api.ai/api-reference/inbox-comments/list-commented-posts.md): Returns inbox posts that have comments, ordered by most-recently-commented. Supports filtering by account, platform, minimum comment count, and date range. Uses cursor-based pagination. YouTube commented posts only appear when the request is scoped with account_id (they are absent from the unfiltere… - [List comments on a post](https://docs.social-api.ai/api-reference/inbox-comments/list-comments-on-a-post.md): Returns comments for a specific inbox post, including per-platform capability flags (can_reply, can_delete, can_hide, can_like, can_private_reply). Uses cursor-based pagination. - [Reply to a comment](https://docs.social-api.ai/api-reference/inbox-comments/reply-to-a-comment.md): Posts a reply on the platform. If comment_id is provided, replies to that specific comment (threaded reply); otherwise replies to the post itself (top-level comment). Consumes 1 interaction credit. - [Delete a comment](https://docs.social-api.ai/api-reference/inbox-comments/delete-a-comment.md): Deletes a comment on the platform and removes it from the inbox. Not all platforms support comment deletion - check the can_delete capability flag. - [Hide a comment](https://docs.social-api.ai/api-reference/inbox-comments/hide-a-comment.md): Hides a comment on the platform so it is not visible to the public, and marks it hidden in the inbox. Supported on Instagram, Facebook, Threads, and YouTube. Check the can_hide capability flag. On Threads, an account connected before 2026-10-17 gets an authorization error until it is reconnected. - [Unhide a comment](https://docs.social-api.ai/api-reference/inbox-comments/unhide-a-comment.md): Restores a previously hidden comment so it is publicly visible again. Supported on Instagram, Facebook, Threads, and YouTube. On Threads, an account connected before 2026-10-17 gets an authorization error until it is reconnected. - [Like a comment](https://docs.social-api.ai/api-reference/inbox-comments/like-a-comment.md): Likes a comment on the platform as the connected account. Supported on Facebook, LinkedIn Pages, and Instagram accounts connected with Facebook Login. Instagram accounts connected with Instagram Login cannot like comments. Check the can_like capability flag. - [Unlike a comment](https://docs.social-api.ai/api-reference/inbox-comments/unlike-a-comment.md): Removes a like from a comment on the platform. Supported on Facebook, LinkedIn Pages, and Instagram accounts connected with Facebook Login. Check the can_like capability flag. - [Send a private reply to a commenter](https://docs.social-api.ai/api-reference/inbox-comments/send-a-private-reply-to-a-commenter.md): Sends a direct message to the author of a comment. Only supported on Instagram and Facebook. Meta allows one private reply per comment, within 7 days of the comment; a second attempt or an expired window returns HTTP 400 with error code platform.instagram.private_reply_ineligible or platform.faceboo… - [List replies to a comment](https://docs.social-api.ai/api-reference/inbox-comments/list-replies-to-a-comment.md): Returns paginated replies to a specific comment. Same response shape as top-level comments. Uses cursor-based pagination. - [List inbox conversations](https://docs.social-api.ai/api-reference/inbox/list-inbox-conversations.md): Returns paginated DM conversations for the authenticated user, optionally filtered by account, platform, and status. - [Get a conversation](https://docs.social-api.ai/api-reference/inbox/get-a-conversation.md): Returns a single inbox conversation by ID. - [Update conversation status](https://docs.social-api.ai/api-reference/inbox/update-conversation-status.md): Sets the status of a conversation to active or archived. - [List messages in a conversation](https://docs.social-api.ai/api-reference/inbox/list-messages-in-a-conversation.md): Returns paginated messages for an inbox conversation, newest first. - [Send a message in a conversation](https://docs.social-api.ai/api-reference/inbox/send-a-message-in-a-conversation.md): Sends an outgoing DM via the connected platform account and records it in the conversation. - [Mark conversation as read](https://docs.social-api.ai/api-reference/inbox/mark-conversation-as-read.md): Resets the unread count on a conversation to zero. - [Get inbox media](https://docs.social-api.ai/api-reference/inbox/get-inbox-media.md): Returns the bytes of an inbound attachment. 504 means retry shortly, not gone. - [Get inbox sync status](https://docs.social-api.ai/api-reference/inbox/get-inbox-sync-status.md): Reports whether a sync is running for the given target and when that target last completed one. Poll this after POST /inbox/sync until state leaves "syncing", then refetch the conversation or message list. - [Start an inbox sync](https://docs.social-api.ai/api-reference/inbox/start-an-inbox-sync.md): Refreshes an account's inbox from the platform. Add conversation_id to refresh a single thread instead. Returns immediately: poll GET /inbox/sync until state leaves "syncing". A sync already running for the same target is returned as-is rather than duplicated. - [React to a message](https://docs.social-api.ai/api-reference/inbox-conversations/react-to-a-message.md): Adds or replaces the account's emoji reaction on a message. Send the emoji character itself. Supported on Instagram and Facebook Messenger. - [Remove a reaction from a message](https://docs.social-api.ai/api-reference/inbox-conversations/remove-a-reaction-from-a-message.md): Removes the account's emoji reaction from a message. - [List Accounts with reviews](https://docs.social-api.ai/api-reference/inbox-reviews/list-accounts-with-reviews.md): Lists your review-capable connected Accounts, each with its live review summary (average rating, total count, last review time). Use this to build the reviews inbox navigation, then GET /inbox/reviews/{account_id} for one Account's reviews. - [List reviews for an Account](https://docs.social-api.ai/api-reference/inbox-reviews/list-reviews-for-an-account.md): Returns one page of reviews for a single connected Account, newest first by default. Currently only Google Business Profile returns reviews. - [Reply to a review](https://docs.social-api.ai/api-reference/inbox-reviews/reply-to-a-review.md): Posts a public reply to a review on the platform (e.g. Google Business Profile). Consumes 1 interaction credit. On Google, replies are moderated: a successful response returns state PENDING and the reply is not publicly visible until it becomes APPROVED. A rejected reply is never published, and the… - [Redeem an invite link](https://docs.social-api.ai/api-reference/invites/redeem-an-invite-link.md): Public endpoint (no auth). Validates the invite token and redirects the user to the platform's OAuth authorization page. On successful OAuth callback, the account is connected to the invite creator's brand. - [List invites for a brand](https://docs.social-api.ai/api-reference/invites/list-invites-for-a-brand.md): Returns all invites (active and used/expired) for a brand, ordered by created_at DESC. - [Create an invite link](https://docs.social-api.ai/api-reference/invites/create-an-invite-link.md): Creates a single-use invite link for an external user to connect a social account to a brand. The brand must not already have a connected account for the specified platform, and no active (unused, unexpired) invite may exist for the same brand+platform combination. - [Revoke an invite](https://docs.social-api.ai/api-reference/invites/revoke-an-invite.md): Marks an invite as used (revoked), preventing it from being redeemed. - [List API keys](https://docs.social-api.ai/api-reference/api-keys/list-api-keys.md): Returns all API keys for the authenticated user, including each key's scope and brand restrictions. - [Create API key](https://docs.social-api.ai/api-reference/api-keys/create-api-key.md): Generates a new API key for the authenticated user. Optionally restrict it to a set of scopes (see GET /keys/scopes) and/or brands. Empty scopes or brand_ids mean unrestricted. - [List API key scopes](https://docs.social-api.ai/api-reference/api-keys/list-api-key-scopes.md): Returns the catalog of scopes assignable to restricted API keys. - [Revoke API key](https://docs.social-api.ai/api-reference/api-keys/revoke-api-key.md): Deactivates an API key. This is irreversible. - [Update API key](https://docs.social-api.ai/api-reference/api-keys/update-api-key.md): Edits an existing key's name, scopes, and brand restrictions in place. The key value is unchanged (no new secret is issued). Empty scopes or brand_ids mean unrestricted. Requires a full-access key or the dashboard. - [Rotate API key](https://docs.social-api.ai/api-reference/api-keys/rotate-api-key.md): Issues a new secret for an existing key, keeping its id, name, scopes, and brand restrictions. The old key value stops working immediately. The new raw key is shown once. Requires a full-access key or the dashboard. - [List media files](https://docs.social-api.ai/api-reference/media/list-media-files.md): Returns a paginated list of uploaded media files for the authenticated user. - [Get storage usage](https://docs.social-api.ai/api-reference/media/get-storage-usage.md): Returns total bytes used, the plan limit, and file count for the authenticated user. - [Upload media (server-side)](https://docs.social-api.ai/api-reference/media/upload-media-server-side.md): Upload a media file directly through the API. - [Get a presigned media upload URL](https://docs.social-api.ai/api-reference/media/get-a-presigned-media-upload-url.md): Returns a presigned PUT URL for client-side media upload. Upload the file directly via HTTP PUT to the returned URL, then call POST /v1/media/:id/verify to confirm. - [Delete a media file](https://docs.social-api.ai/api-reference/media/delete-a-media-file.md) - [Verify a media upload](https://docs.social-api.ai/api-reference/media/verify-a-media-upload.md): Confirms that a presigned-URL upload completed successfully and marks the media as ready. - [Start a migration](https://docs.social-api.ai/api-reference/migration/start-a-migration.md): Starts a migration from another provider with an API key from your account there, and returns the first assessment of your accounts. Calling it again replaces the key. You must accept the current authorisation text: send its `version` from `GET /v1/migrations/{provider}`. Dashboard sessions only; AP… - [Get a migration](https://docs.social-api.ai/api-reference/migration/get-a-migration.md): Returns your migration from a provider: the authorisation text to accept before starting, and once started, your accounts, the Brands and plan they need, and progress. If the provider cannot be read, the response is still 200 with `assessment` null and `assessment_error` set. The assessment can be u… - [Stop a migration](https://docs.social-api.ai/api-reference/migration/stop-a-migration.md): Stops the migration from a provider. Requests sent through the base URL with that key stop working. Dashboard sessions only; API keys get 403. - [Get daily Facebook Page insights](https://docs.social-api.ai/api-reference/facebook/get-daily-facebook-page-insights.md): Returns one point per day for one Page of a connected Facebook account: followers at the end of the day, plus that day's views, reach and post engagements. Days with no data are omitted. Same permission errors as the Page insights summary. - [Get Facebook Page insights summary](https://docs.social-api.ai/api-reference/facebook/get-facebook-page-insights-summary.md): Returns trailing-30-day Page insight aggregates (followers, views, reach, post engagements, net follower change) for one Page of a connected Facebook account. A Page connected before 2026-10-17, or whose login declined the insights permission, returns 403 platform.facebook.insights_scope_missing and… - [List a Facebook login's Pages](https://docs.social-api.ai/api-reference/facebook/list-a-facebook-logins-pages.md): Lists every Page this login can manage, live from Meta, merged with assignment state. Pages granted after the last OAuth exchange appear here without re-authenticating. assignable reflects ownership only; the 5-page-per-brand cap is enforced when assigning. - [Assign a Facebook Page to a brand](https://docs.social-api.ai/api-reference/facebook/assign-a-facebook-page-to-a-brand.md): Assigns one Page from this login to the given brand. Each Page belongs to exactly one brand, so a Page currently held by another brand of yours is moved to the target brand. Each brand can connect up to 5 Facebook Pages, a hard cap. Assigning beyond that limit is refused. - [Update a Google Business Profile location](https://docs.social-api.ai/api-reference/google/update-a-google-business-profile-location.md): Writes the location's public profile: name, description, phone numbers, address, website, categories, opening hours, service area. Only the fields you send are touched. A field you omit is left as it is, and a field you send with an empty value is CLEARED, which is how you remove a phone number or a… - [Get Google Business Profile performance metrics](https://docs.social-api.ai/api-reference/google/get-google-business-profile-performance-metrics.md): Returns daily time series for a location: how many people saw it on Google Search and Maps, and how many then called, asked for directions, messaged, booked, ordered, or clicked through to the website. start_date and end_date are inclusive and formatted YYYY-MM-DD. metric takes a comma-separated lis… - [List a Google Business Profile location's media](https://docs.social-api.ai/api-reference/google/list-a-google-business-profile-locations-media.md): Lists the photos and videos on a location's public profile: its logo, cover, interior shots, and so on. This is profile media, not the media attached to a post. Set contributed=true to read the separate, read-only gallery of photos customers submitted; those items carry an attribution block that Goo… - [Add media to a Google Business Profile location](https://docs.social-api.ai/api-reference/google/add-media-to-a-google-business-profile-location.md): Attaches one photo or video to a location's public profile under the given category. media takes exactly one item in the same form the publishing endpoints accept: a stored media library id (source_type media_id), a public URL (url), or a reference to bytes you uploaded to Google yourself (platform_… - [Get one Google Business Profile media item](https://docs.social-api.ai/api-reference/google/get-one-google-business-profile-media-item.md): Returns one photo or video from a location's profile. mediaId accepts either the bare id or the full Google resource name returned by the list endpoint. - [Remove media from a Google Business Profile location](https://docs.social-api.ai/api-reference/google/remove-media-from-a-google-business-profile-location.md): Deletes one photo or video you added to a location's profile. Photos contributed by customers cannot be deleted through the API and return a permission error; use the takedown_url on the item instead. - [Get the search keywords that surfaced a Google Business Profile](https://docs.social-api.ai/api-reference/google/get-the-search-keywords-that-surfaced-a-google-business-profile.md): Returns the keywords people searched before seeing the location, aggregated by month over an inclusive YYYY-MM range. A low-volume keyword comes back with threshold and is_threshold=true instead of value: Google withholds the exact count and gives an upper bound, so treating a threshold as a count o… - [List a Google login's Business Profile locations](https://docs.social-api.ai/api-reference/google/list-a-google-logins-business-profile-locations.md): Lists every Business Profile location this login can manage, live from Google, merged with assignment state. Locations added in Google Business Profile after the last authorization appear here without re-authenticating. assignable reflects ownership only. login_email identifies the Google account it… - [Assign a Google Business Profile location to a brand](https://docs.social-api.ai/api-reference/google/assign-a-google-business-profile-location-to-a-brand.md): Assigns one location from this login to the given brand, without re-doing OAuth. Each location belongs to exactly one brand, and each brand holds at most one Google Business Profile. - [Accept an Instagram collaboration invite](https://docs.social-api.ai/api-reference/instagram/accept-an-instagram-collaboration-invite.md): Accepts a pending collaboration invite on an Instagram media object, publishing the co-authored post to this account's feed. Call with the invited account, not the publishing account. Invites expire 14 days after they are sent. - [Decline an Instagram collaboration invite](https://docs.social-api.ai/api-reference/instagram/decline-an-instagram-collaboration-invite.md): Declines a pending collaboration invite on an Instagram media object. The post will not appear on this account's feed. Call with the invited account, not the publishing account. - [List collaborators on an Instagram post](https://docs.social-api.ai/api-reference/instagram/list-collaborators-on-an-instagram-post.md): Returns the collaborators invited on a co-authored Instagram post and the state of each invite (accepted, pending, declined). Readable only by the account that published the media: Meta scopes co-authored media data to the publisher, so a collaborating account cannot read this edge. Collaborators ca… - [Get an Instagram messaging participant's profile](https://docs.social-api.ai/api-reference/instagram/get-an-instagram-messaging-participants-profile.md): Returns the profile Instagram exposes for a messaging participant, including the follow relationship in both directions (is_user_follow_business, is_business_follow_user). Works for an Instagram account connected either directly or through a linked Facebook Page. The follow relationship is current a… - [List active Instagram stories](https://docs.social-api.ai/api-reference/instagram/list-active-instagram-stories.md): Returns the currently-active stories for a connected Instagram account. Stories are ephemeral and expire about 24 hours after posting; each item carries is_story and a computed expires_at in metadata. Returns 501 for non-Instagram accounts. - [Get Instagram account insights summary](https://docs.social-api.ai/api-reference/instagram/get-instagram-account-insights-summary.md): Returns live profile counts plus trailing-30-day insight totals (reach, views, interactions, engaged accounts, net follower change) for a connected Instagram account. The totals need the analytics.read permission. An account without it returns 403 account.permission_missing: add analytics.read to th… - [Get LinkedIn insights (beta)](https://docs.social-api.ai/api-reference/linkedin/get-linkedin-insights-beta.md): Beta. Returns the follower count plus per-post performance for a connected LinkedIn account. For a company Page, `posts` covers the Page's recent posts. For a personal profile connected with `connection_type` `profile`, `posts` covers the 5 most recent posts published to it through SocialAPI, and `c… - [Get Threads insights](https://docs.social-api.ai/api-reference/threads/get-threads-insights.md): Returns engagement metrics for a single Threads post (level=media) or for the connected account (level=account). An account connected before 2026-10-17 returns 403 platform.threads.insights_scope_missing until it is reconnected. Media metrics are views, likes, replies, reposts, quotes and shares. Ac… - [Look up a public Threads profile (beta)](https://docs.social-api.ai/api-reference/threads/look-up-a-public-threads-profile-beta.md): Beta. Resolves a public Threads profile by exact username and returns its public metrics. Requires the threads_profile_discovery Threads permission, which is pending Meta App Review, so calls may return an upstream authorization error for accounts outside the app's tester roster until that permissio… - [Get TikTok account summary](https://docs.social-api.ai/api-reference/tiktok/get-tiktok-account-summary.md) - [Re-sync a TikTok account's videos](https://docs.social-api.ai/api-reference/tiktok/re-sync-a-tiktok-accounts-videos.md) - [Send a template message](https://docs.social-api.ai/api-reference/whatsapp/send-a-template-message.md): Sends an approved WhatsApp template message to a recipient phone number. Template messages can be sent outside the 24-hour customer service window. The template must already be APPROVED on the WABA, and the language code must match an approved variant. Component parameter order must match the templa… - [List message templates](https://docs.social-api.ai/api-reference/whatsapp/list-message-templates.md): Returns all message templates configured on the WhatsApp Business Account (WABA) associated with this connected account. Templates include approved, pending, rejected, and paused entries. Use the after cursor from paging.cursors to fetch subsequent pages. - [Create a message template](https://docs.social-api.ai/api-reference/whatsapp/create-a-message-template.md): Submits a new message template to the WhatsApp Business Account (WABA) for review. The request body is the raw WhatsApp Cloud API template payload (name, category, language, components). New templates start in PENDING status; Meta reviews them and the status transitions to APPROVED or REJECTED async… - [Delete a message template](https://docs.social-api.ai/api-reference/whatsapp/delete-a-message-template.md): Deletes a template by name from the WhatsApp Business Account (WABA) associated with this connected account. WhatsApp deletes all language variants that share the given name. Templates cannot be deleted while they are being used in active campaigns. - [Get a WhatsApp Business Profile](https://docs.social-api.ai/api-reference/whatsapp/get-a-whatsapp-business-profile.md): Returns the public business profile for a WhatsApp phone number, including about text, address, description, contact email, websites, and vertical. The profile is visible to customers in the WhatsApp chat header. - [Update a WhatsApp Business Profile](https://docs.social-api.ai/api-reference/whatsapp/update-a-whatsapp-business-profile.md): Updates one or more fields of the public business profile (about, address, description, email, websites, vertical, profile_picture_handle). Only provided fields are changed. The profile picture itself is changed by passing a profile_picture_handle obtained from the Resumable Upload API; profile_pict… - [Deregister a phone number from WhatsApp Business](https://docs.social-api.ai/api-reference/whatsapp/deregister-a-phone-number-from-whatsapp-business.md): Releases the phone number from WhatsApp Business, freeing it for use with another Business Solution Provider (BSP). This does not delete the connected account on SocialAPI; the account remains until it is disconnected explicitly. - [Register a phone number with WhatsApp Business](https://docs.social-api.ai/api-reference/whatsapp/register-a-phone-number-with-whatsapp-business.md): Registers a previously verified phone number with WhatsApp Business and sets the 6-digit two-step verification PIN. The phone number must be verified via verify-code first. The PIN must be retained by the caller: losing it triggers a mandatory 7-day wait before it can be reset. A number that stays o… - [Request a phone number verification code](https://docs.social-api.ai/api-reference/whatsapp/request-a-phone-number-verification-code.md): Asks WhatsApp to send a one-time verification code to the phone number via SMS or voice call. The code is delivered to the underlying phone line, not to the API caller; follow up with verify-code once the user receives it. Step 1 of the phone-number registration flow (request-code, verify-code, regi… - [Get phone number registration status](https://docs.social-api.ai/api-reference/whatsapp/get-phone-number-registration-status.md): Returns whether a phone number is verified and registered with WhatsApp Business. Used by client UIs to decide which step of the registration flow to show. - [Verify a phone number with a code](https://docs.social-api.ai/api-reference/whatsapp/verify-a-phone-number-with-a-code.md): Submits the 6-digit code received via SMS or voice to prove ownership of the phone number. Once verified, the phone number can be registered with WhatsApp Business. Codes expire quickly; if verification fails, request a new code. - [Validate a message template](https://docs.social-api.ai/api-reference/whatsapp/validate-a-message-template.md): Dry-run validation of a WhatsApp message template against the Cloud API rules (name format, component cardinality, header format, text limits, placeholder sequencing, button constraints). Returns errors for hard violations that WhatsApp would reject and warnings for best-practice issues. Performs no… - [Get a message template](https://docs.social-api.ai/api-reference/whatsapp/get-a-message-template.md): Returns a single message template by its WhatsApp template ID. Requires an active WhatsApp account on your workspace. The template is identified by its WhatsApp template ID. - [Edit a message template](https://docs.social-api.ai/api-reference/whatsapp/edit-a-message-template.md): Updates the components of an existing message template by its WhatsApp template ID. Only APPROVED templates can be edited, and editing resets the template to PENDING for re-review. APPROVED templates are limited to one edit per day. - [Get YouTube channel summary](https://docs.social-api.ai/api-reference/youtube/get-youtube-channel-summary.md) - [Re-sync a YouTube account's videos](https://docs.social-api.ai/api-reference/youtube/re-sync-a-youtube-accounts-videos.md) - [Edit a published YouTube video (title, description, visibility, Studio tags)](https://docs.social-api.ai/api-reference/youtube/edit-a-published-youtube-video-title-description-visibility-studio-tags.md) - [Edit a YouTube comment](https://docs.social-api.ai/api-reference/youtube/edit-a-youtube-comment.md): Edits the text of one of the connected account's own YouTube comments via comments.update. Only the comment author (the connected account) can edit. YouTube only. - [Moderate a YouTube comment](https://docs.social-api.ai/api-reference/youtube/moderate-a-youtube-comment.md): Sets the moderation status of a YouTube comment (published, held_for_review, or rejected), optionally banning the author. ban_author is only valid with status=rejected. YouTube only. - [List all posts](https://docs.social-api.ai/api-reference/posts/list-all-posts.md): Returns posts with rich filtering and cursor pagination. Supports filtering by status, platform, account_ids, date range, and text search. - [Create or schedule a post](https://docs.social-api.ai/api-reference/posts/create-or-schedule-a-post.md): Creates a post for one or more connected accounts. Set `publish_now: true` to publish immediately: the post is accepted with status `publishing` and delivery runs in the background (so slow reel/video uploads do not block the request). The terminal status (`published`, `partial`, or `failed`) arrive… - [Bulk import posts from CSV](https://docs.social-api.ai/api-reference/posts/bulk-import-posts-from-csv.md): Upload a CSV file to create multiple posts. Use dry_run=true to validate without creating. Columns, in order: text, title, account_ids, scheduled_at, visibility, first_comment, platform_data, board_id. Only text is required. account_ids is pipe separated. - [Get platform constraints](https://docs.social-api.ai/api-reference/posts/get-platform-constraints.md): Returns media and text constraints for all supported platforms. Cacheable. - [Validate post content](https://docs.social-api.ai/api-reference/posts/validate-post-content.md): Dry-run validation. Returns errors for hard limit violations and warnings for best-practice issues. - [Get a single post](https://docs.social-api.ai/api-reference/posts/get-a-single-post.md): Fetch a post with all platform delivery details. Accepts the SocialAPI post ID or a platform post ID (the platform's native ID for a published target). - [Delete or cancel a post](https://docs.social-api.ai/api-reference/posts/delete-or-cancel-a-post.md): Deletes a draft/scheduled/failed post locally, or deletes a published post from every platform that supports it. Platforms that do not support deletion (or fail) keep their copy live and the post is kept rather than removed. Returns a per-platform result. - [Update a post](https://docs.social-api.ai/api-reference/posts/update-a-post.md): Updates the text, media, schedule time, targets, or hidden status of a pending post. Only posts in `draft`, `scheduled`, or `failed` status can be updated. `queue_id` moves the post to another Queue, and `queue_id: null` takes it out of its Queue and keeps its time. Omit `targets` to keep the curren… - [Get post metrics](https://docs.social-api.ai/api-reference/posts/get-post-metrics.md): Fetches engagement metrics from platform APIs for a published post. Accepts the SocialAPI post ID or a platform post ID. Instagram targets add views, reach and interactions, plus follows, profile visits and profile actions on feed posts, and watch time, skip rate and crossposted views on Reels. A me… - [Publish a draft post now](https://docs.social-api.ai/api-reference/posts/publish-a-draft-post-now.md): Publishes a post in `draft` or `scheduled` status immediately. The post is accepted with status `publishing` and delivery runs in the background (so slow reel/video uploads do not block the request); the terminal status arrives via the `post.published`/ `post.partial`/`post.failed` webhooks and by p… - [Retry a failed post](https://docs.social-api.ai/api-reference/posts/retry-a-failed-post.md): Re-attempts publication of a post in `failed` or `partial` status. Consumes 1 post credit. - [Unpublish a post](https://docs.social-api.ai/api-reference/posts/unpublish-a-post.md): Unpublishes a published post from a specific account (if account_id provided) or all accounts. - [List Queues](https://docs.social-api.ai/api-reference/queues/list-queues.md): Lists your Queues, grouped by Brand, oldest first. Filter to one Brand with brand_id. - [Create a Queue](https://docs.social-api.ai/api-reference/queues/create-a-queue.md): Creates a Queue on a Brand: a weekly list of posting times in one timezone. A post created with queue_id takes the earliest free time. day is a lowercase English weekday name and time is HH:MM, both in the Queue's timezone. A Brand holds at most 20 Queues and always has exactly one default. The firs… - [Get a Queue](https://docs.social-api.ai/api-reference/queues/get-a-queue.md): Returns one Queue. - [Delete a Queue](https://docs.social-api.ai/api-reference/queues/delete-a-queue.md): Deletes a Queue. Its posts keep their scheduled times and are no longer queued; released_count is how many there were. If it was the default, the Brand's oldest remaining Queue becomes the default. - [Update a Queue](https://docs.social-api.ai/api-reference/queues/update-a-queue.md): Updates the fields you send and keeps the rest. slots replaces the whole list. Set active to false to pause the Queue: posts already in it keep their times, and no new post can join it. is_default can only be set to true, which makes this Queue the Brand's default; to change the default, set another… - [Preview a Queue's next times](https://docs.social-api.ai/api-reference/queues/preview-a-queues-next-times.md): Lists the next free times of a Queue as RFC 3339 with the Queue's local offset, soonest first. Works on a paused Queue. A forecast, not a reservation: send queue_id, never copy a previewed time into scheduled_at. - [Get current user](https://docs.social-api.ai/api-reference/users/get-current-user.md): Returns the authenticated user's profile (id, email, plan tier, onboarding flag, beta_tester flag, allowed_platforms list, billing_blocked state). - [Delete user account](https://docs.social-api.ai/api-reference/users/delete-user-account.md): Permanently deletes the authenticated user account and all associated data (API keys, connected accounts, usage logs). Any active subscription is cancelled immediately, with no refund for the remainder of the current billing period. This action is irreversible. - [Update current user](https://docs.social-api.ai/api-reference/users/update-current-user.md): Updates the authenticated user's profile. Supports setting onboarding=false to mark onboarding as complete, and optionally recording use_case, referral and job_role. The response reflects the current billing_blocked state, unaffected by this update. The response includes the caller's team role: "adm… - [List webhook endpoints](https://docs.social-api.ai/api-reference/webhooks/list-webhook-endpoints.md): Returns all webhook endpoints for the authenticated user. - [Create webhook endpoint](https://docs.social-api.ai/api-reference/webhooks/create-webhook-endpoint.md): Registers a new webhook endpoint and performs a live reachability ping. If the endpoint is unreachable or returns an unexpected response, the request fails with 400 (webhook_verification_failed). The generated secret is returned once - store it securely. - [List available webhook event types](https://docs.social-api.ai/api-reference/webhooks/list-available-webhook-event-types.md): Returns the catalog of webhook event types you can subscribe to, grouped by category (posts, inbox, accounts). - [Get webhook endpoint](https://docs.social-api.ai/api-reference/webhooks/get-webhook-endpoint.md): Returns the configuration and aggregate delivery stats for a single webhook endpoint owned by the caller. - [Delete webhook endpoint](https://docs.social-api.ai/api-reference/webhooks/delete-webhook-endpoint.md): Removes a webhook endpoint. Future events will not be delivered to this URL. - [Update webhook endpoint](https://docs.social-api.ai/api-reference/webhooks/update-webhook-endpoint.md): Partially updates a webhook endpoint. All fields are optional; at least one must be provided. - [List webhook deliveries](https://docs.social-api.ai/api-reference/webhooks/list-webhook-deliveries.md): Returns recent delivery attempts for a webhook endpoint. Optionally filter by status (success, failed, pending) or event_type. Cursor-paginated. - [Get webhook delivery](https://docs.social-api.ai/api-reference/webhooks/get-webhook-delivery.md): Returns the full record of a single webhook delivery attempt, including request payload, response status, response body excerpt, and timing. - [Retry webhook delivery](https://docs.social-api.ai/api-reference/webhooks/retry-webhook-delivery.md): Requeues a failed webhook delivery for another attempt. Returns the updated delivery record. - [Send test webhook delivery](https://docs.social-api.ai/api-reference/webhooks/send-test-webhook-delivery.md): Sends a synthetic event payload to the webhook endpoint to validate signature, reachability, and consumer handling. Returns the delivery result. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) ## Optional - [Support](mailto:support@social-api.ai) - [GitHub](https://github.com/SocialAPI-AI) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.