# SocialAPI.AI

## Docs

- [Complete OAuth2 account connection](https://docs.social-api.ai/api-reference/accounts/complete-oauth2-account-connection.md): Exchanges an authorization code (received from the platform callback) for tokens. Validates the state token against Redis to prevent CSRF. State is one-time-use.
- [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.
- [Disconnect a social account](https://docs.social-api.ai/api-reference/accounts/disconnect-a-social-account.md): Soft-deletes a connected account. It will no longer appear in the accounts list and all API calls using this account will return 404.
- [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.
- [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.
- [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.
- [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.
- [List API keys](https://docs.social-api.ai/api-reference/api-keys/list-api-keys.md): Returns all API keys for the authenticated user.
- [Revoke API key](https://docs.social-api.ai/api-reference/api-keys/revoke-api-key.md): Deactivates an API key. This is irreversible.
- [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.
- [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.
- [Update a brand](https://docs.social-api.ai/api-reference/brands/update-a-brand.md): Renames a brand.
- [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).
- [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)
- [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.
- [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, and Threads. Check the can_hide capability flag.
- [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 Instagram, Facebook, Twitter/X, and Reddit. Check the can_like capability flag.
- [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.
- [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.
- [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.
- [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.
- [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. This is a one-time DM triggered by a specific comment — only supported on Instagram and Facebook. Check the can_private_reply capability flag.
- [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, and Threads.
- [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 Instagram, Facebook, Twitter/X, and Reddit.
- [Delete a review reply](https://docs.social-api.ai/api-reference/inbox-reviews/delete-a-review-reply.md): Deletes an existing review reply from the platform. Not yet implemented — returns 501.
- [List reviews](https://docs.social-api.ai/api-reference/inbox-reviews/list-reviews.md): Fetches reviews across connected accounts via real-time fan-out to platform APIs. Supports filtering by account and platform. Reviews are proxied live and not stored — results may vary based on platform availability. 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). The reply is visible to anyone who views the review. Consumes 1 interaction credit.
- [Update a review reply](https://docs.social-api.ai/api-reference/inbox-reviews/update-a-review-reply.md): Updates the text of an existing review reply. Not yet implemented — returns 501.
- [Get a conversation](https://docs.social-api.ai/api-reference/inbox/get-a-conversation.md): Returns a single inbox conversation by ID.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Delete a media file](https://docs.social-api.ai/api-reference/media/delete-a-media-file.md)
- [Get a presigned media upload URL](https://docs.social-api.ai/api-reference/media/get-a-presigned-media-upload-url.md): Returns a presigned S3 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.
- [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.
- [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.
- [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 server.
- [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.
- [List brand mentions](https://docs.social-api.ai/api-reference/mentions/list-brand-mentions.md): Fetches posts and stories where your brand account was mentioned or tagged. Results are sorted newest-first. Returns 501 for platforms that do not support mention tracking.
- [Add an allowed redirect URI](https://docs.social-api.ai/api-reference/oauth/add-an-allowed-redirect-uri.md): Registers a new redirect URI in the whitelist. Maximum 20 per user. The URI must use HTTPS (HTTP is allowed only for localhost and 127.0.0.1).
- [List allowed redirect URIs](https://docs.social-api.ai/api-reference/oauth/list-allowed-redirect-uris.md): Returns all whitelisted OAuth redirect URIs for the authenticated user. These URIs can be used as the redirect_uri parameter in POST /v1/accounts/connect.
- [Remove an allowed redirect URI](https://docs.social-api.ai/api-reference/oauth/remove-an-allowed-redirect-uri.md): Deletes a redirect URI from the whitelist by ID.
- [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.
- [Create or schedule a post](https://docs.social-api.ai/api-reference/posts/create-or-schedule-a-post.md): Publishes to one or more connected accounts. If scheduled_at is omitted the post is published immediately (synchronous — blocks until all accounts respond). If scheduled_at is set the post is queued for future publication (asynchronous). Omit account_ids and scheduled_at to create a draft. Consumes…
- [Delete or cancel a post](https://docs.social-api.ai/api-reference/posts/delete-or-cancel-a-post.md): Cancels a scheduled post or deletes a failed/published post across all platforms.
- [Get a single post](https://docs.social-api.ai/api-reference/posts/get-a-single-post.md): Fetch a post by its ID with all platform delivery details.
- [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.
- [Get post metrics](https://docs.social-api.ai/api-reference/posts/get-post-metrics.md): Fetches live engagement metrics from platform APIs for a published post.
- [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.
- [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.
- [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.
- [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.
- [Search interactions](https://docs.social-api.ai/api-reference/search/search-interactions.md): Full-text search across all platforms and interaction types. Accepts query param `q` for the search term; optionally filter by `platform` and `type`. Fan-out to all relevant connectors with merged, ranked results. **Not yet implemented** — returns 501.
- [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 come from Stripe subscription or rolling 30-day windows for free users.
- [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). This action is irreversible.
- [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).
- [Update current user](https://docs.social-api.ai/api-reference/users/update-current-user.md): Updates the authenticated user's profile. Currently only supports setting onboarding=false to mark onboarding as complete.
- [Create webhook endpoint](https://docs.social-api.ai/api-reference/webhooks/create-webhook-endpoint.md): Registers a new webhook endpoint. The generated secret is returned once — store it securely.
- [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.
- [List webhook endpoints](https://docs.social-api.ai/api-reference/webhooks/list-webhook-endpoints.md): Returns all webhook endpoints for the authenticated user.
- [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.
- [Facebook](https://docs.social-api.ai/connectors/facebook.md): Connect and interact with Facebook Pages via the Meta Graph API.
- [Google Business Profile](https://docs.social-api.ai/connectors/google-reviews.md): Connect and interact with Google Business Profile locations via the Google Business Profile API.
- [Instagram](https://docs.social-api.ai/connectors/instagram.md): Connect and interact with Instagram accounts via the Meta Graph API.
- [LinkedIn](https://docs.social-api.ai/connectors/linkedin.md): Connect and interact with LinkedIn profiles and pages via the LinkedIn API.
- [Connectors Overview](https://docs.social-api.ai/connectors/overview.md): Platform capabilities and feature matrix.
- [Threads](https://docs.social-api.ai/connectors/threads.md): Connect and interact with Threads accounts via the Meta Threads API.
- [TikTok](https://docs.social-api.ai/connectors/tiktok.md): Connect and interact with TikTok accounts via the TikTok API.
- [Trustpilot](https://docs.social-api.ai/connectors/trustpilot.md): Trustpilot connector for SocialAPI.AI.
- [X / Twitter](https://docs.social-api.ai/connectors/twitter.md): Connect and interact with X (Twitter) accounts via the X API v2.
- [Twitter BYOK setup](https://docs.social-api.ai/connectors/twitter-byok.md): Bring your own Twitter Developer app to connect Twitter accounts to SocialAPI.
- [YouTube](https://docs.social-api.ai/connectors/youtube.md): Connect and interact with YouTube channels via the YouTube Data API.
- [Authentication](https://docs.social-api.ai/guides/authentication.md): How to authenticate requests using API keys, dashboard JWTs, or OAuth 2.1 tokens.
- [Core concepts](https://docs.social-api.ai/guides/concepts.md): The five nouns SocialAPI's API exposes (Brand, Account, Post, Interaction, Capability) and how they fit together.
- [Error Handling](https://docs.social-api.ai/guides/errors.md): Error response format and all error codes.
- [Interaction IDs](https://docs.social-api.ai/guides/interaction-ids.md): How SocialAPI IDs encode type and platform.
- [OAuth Flows](https://docs.social-api.ai/guides/oauth.md): Connecting social accounts via platform OAuth and authenticating MCP clients via OAuth 2.1.
- [Pagination](https://docs.social-api.ai/guides/pagination.md): Page through large result sets using cursors.
- [Platform credentials](https://docs.social-api.ai/guides/platform-credentials.md): Whose OAuth app do you authenticate through? SocialAPI provides managed apps for every connector except Twitter.
- [Platform Support](https://docs.social-api.ai/guides/platforms.md): Which platforms support which capabilities.
- [Plans & Limits](https://docs.social-api.ai/guides/rate-limits.md): Resource limits, billing periods, export quotas, and how to monitor your usage.
- [Webhooks](https://docs.social-api.ai/guides/webhooks.md): Receive real-time notifications when interactions arrive and posts are published on your connected accounts.
- [SocialAPI.AI](https://docs.social-api.ai/index.md): Unified social media API. Manage your inbox, publish content, and monitor engagement across Instagram, Facebook, Threads, Google Business, TikTok, LinkedIn, and YouTube through a single REST API.
- [ChatGPT](https://docs.social-api.ai/integrations/chatgpt.md): Connect [SocialAPI.AI](https://social-api.ai) to ChatGPT on web, desktop, and mobile.
- [Claude](https://docs.social-api.ai/integrations/claude.md): Connect [SocialAPI.AI](https://social-api.ai) to Claude on web, desktop, CLI, and mobile.
- [Cursor](https://docs.social-api.ai/integrations/cursor.md): Connect [SocialAPI.AI](https://social-api.ai) to Cursor via config file or Settings UI.
- [Mistral / Le Chat](https://docs.social-api.ai/integrations/mistral.md): Connect [SocialAPI.AI](https://social-api.ai) to Le Chat on web and mobile.
- [Use with AI Assistants](https://docs.social-api.ai/integrations/overview.md): Connect [SocialAPI.AI](https://social-api.ai) to Claude, ChatGPT, Mistral, Cursor, VS Code, and other AI tools as an MCP server.
- [VS Code + GitHub Copilot](https://docs.social-api.ai/integrations/vscode.md): Connect [SocialAPI.AI](https://social-api.ai) to VS Code with GitHub Copilot via config file or Command Palette.
- [Facebook publishing](https://docs.social-api.ai/posts/facebook.md): Full reference for publishing Facebook Page posts via SocialAPI, including text, link preview, photo, and video posts.
- [Google Business Profile publishing](https://docs.social-api.ai/posts/google.md): Full reference for publishing Google Business Profile local posts via SocialAPI, including text, image, event, offer, and alert posts.
- [Instagram publishing](https://docs.social-api.ai/posts/instagram.md): Full reference for publishing Instagram posts via SocialAPI, including images, videos, reels, carousels, and platform-specific parameters.
- [LinkedIn publishing](https://docs.social-api.ai/posts/linkedin.md): Full reference for publishing LinkedIn organization page posts via SocialAPI, including text, image, video, and multi-image carousel posts.
- [Posts overview](https://docs.social-api.ai/posts/overview.md): Compare post publishing capabilities across all supported platforms.
- [Threads publishing](https://docs.social-api.ai/posts/threads.md): Full reference for publishing Threads posts via SocialAPI, including text, images, videos, and carousels, plus platform-specific parameters.
- [TikTok publishing](https://docs.social-api.ai/posts/tiktok.md): Full reference for publishing TikTok videos and photo carousels via SocialAPI, including platform-specific parameters, creator validation, and polling behavior.
- [Quickstart](https://docs.social-api.ai/quickstart.md): Make your first API call in under 5 minutes.

## OpenAPI Specs

- [openapi](https://docs.social-api.ai/api-reference/openapi.json)

## Optional

- [Support](mailto:support@social-api.ai)
- [GitHub](https://github.com/SocialAPI-AI)