Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.social-api.ai/llms.txt

Use this file to discover all available pages before exploring further.

SocialAPI provides a unified inbox API for reading and responding to all inbound engagement across your connected accounts. Comments, DMs, reviews, and mentions are accessed through consistent endpoints with the same response shape regardless of platform. SocialAPI never stores interaction content in its database. Every inbox call proxies live data from the platform API, so you always see the latest state.

Comments

List comments across all connected accounts, reply, and moderate.

Endpoints

MethodPathDescription
GET/v1/inbox/commentsList comments across all accounts
POST/v1/inbox/comments/:idReply to a comment
POST/v1/inbox/comments/:id/moderateHide, delete, or like a comment

Platform capabilities

PlatformReplyHideLikeDeletePrivate reply
InstagramYesYesYesYesYes
FacebookYesYesYesYesYes
ThreadsYesYesNoNoNo
GoogleYesNoNoNoNo
LinkedInYesNoNoYesNo
YouTubeYesYesNoYesNo
TikTokNoNoNoNoNo
Each comment includes a capabilities object so your code can check what actions are available before attempting them.

Example: list and reply

# List comments
curl https://api.social-api.ai/v1/inbox/comments \
  -H "Authorization: Bearer $SOCAPI_KEY"

# Reply to a comment
curl -X POST https://api.social-api.ai/v1/inbox/comments/sapi_cmt_aW5zdGF.../reply \
  -H "Authorization: Bearer $SOCAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Thanks for the feedback!" }'

Direct messages

Read conversations and send messages across platforms that support DMs.

Endpoints

MethodPathDescription
GET/v1/inbox/conversationsList DM conversations
GET/v1/inbox/conversations/:id/messagesGet messages in a conversation
POST/v1/inbox/conversations/:id/messagesSend a message

Platform support

PlatformDMs supportedNotes
InstagramYes24-hour messaging window for non-followers
FacebookYesVia Messenger Send API, 24-hour response window
LinkedInNoPlatform API does not expose DMs
TikTokNoNot available via API
GoogleNoNot applicable
ThreadsNoNot available via API
YouTubeNoNot available via API

Example: list conversations and send a message

# List conversations
curl https://api.social-api.ai/v1/inbox/conversations \
  -H "Authorization: Bearer $SOCAPI_KEY"

# Send a message in a conversation
curl -X POST https://api.social-api.ai/v1/inbox/conversations/sapi_dm_bWV0YS4.../messages \
  -H "Authorization: Bearer $SOCAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Your order has shipped!" }'

Reviews

Read and reply to reviews on platforms that support them.

Endpoints

MethodPathDescription
GET/v1/inbox/reviewsList reviews
POST/v1/inbox/reviews/:idReply to a review

Platform support

PlatformReviews
GoogleYes (Google Business Profile)
All othersNo

Example

# List reviews
curl https://api.social-api.ai/v1/inbox/reviews \
  -H "Authorization: Bearer $SOCAPI_KEY"

# Reply to a review
curl -X POST https://api.social-api.ai/v1/inbox/reviews/sapi_rev_Z29vZ2xl.../reply \
  -H "Authorization: Bearer $SOCAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Thank you for the review!" }'

Mentions

Read mentions of your accounts across platforms.

Endpoint

MethodPathDescription
GET/v1/inbox/mentionsList mentions

Platform support

PlatformMentions
InstagramYes
FacebookYes
All othersNo

Example

curl https://api.social-api.ai/v1/inbox/mentions \
  -H "Authorization: Bearer $SOCAPI_KEY"

Interaction IDs

Every interaction returned by the inbox has a stable ID with a type prefix:
PrefixType
sapi_cmt_Comment
sapi_dm_DM
sapi_rev_Review
sapi_mnt_Mention
The suffix encodes the platform and the platform-native ID, so you can route actions without a database lookup. See Interaction IDs for the full encoding scheme.

Webhooks

SocialAPI can notify your server when new inbound interactions arrive (new comment, new DM, new review). Register a webhook endpoint and subscribe to the event types you care about. See Webhooks for setup and event reference.