SocialClaw API documentation

Complete SocialClaw API reference: every endpoint searchable with a try-it console and request samples in Python, TypeScript, Go, PHP, Ruby, and more, generated from the live OpenAPI 3.1 contract.

The interactive reference requires JavaScript. The full contract covering all 81 endpoints is available as OpenAPI 3.1 JSON and as plain text at llms-full.txt. Public integration routes authenticate with Authorization: Bearer $SOCIALCLAW_API_KEY.

Status and Authentication

GET /health — Service health
POST /v1/keys/validate — Validate API key
GET /v1/keys — List API keys
POST /v1/keys — Create API key
DELETE /v1/keys/{keyId} — Revoke API key
GET /v1/me/usage — Workspace usage
GET /v1/workspace/health — Workspace health
GET /v1/jobs — List jobs

Connections and Accounts

POST /v1/connections/start — Start connection
GET /v1/connections — List connections
GET /v1/connections/health — Connections health
GET /v1/connections/{connectionId} — Connection status
GET /v1/accounts — List connected accounts
GET /v1/accounts/capabilities — List account capabilities
GET /v1/accounts/{accountId}/capabilities — Get account capabilities
GET /v1/accounts/{accountId}/settings — Get publish settings
GET /v1/accounts/{accountId}/actions — List discovery actions
POST /v1/accounts/{accountId}/actions/{actionId} — Run discovery action
DELETE /v1/accounts/{accountId} — Disconnect account
GET /oauth/{provider}/callback — OAuth provider callback

Publishing Runs and Posts

GET /v1/posts — List posts
GET /v1/posts/{postId} — Get post detail
GET /v1/posts/{postId}/attempts — List post attempts
POST /v1/posts/{postId}/reconcile — Reconcile post
POST /v1/posts/validate — Validate schedule
POST /v1/campaigns/preview — Preview campaign
POST /v1/posts/apply — Create run
GET /v1/runs/{runId}/status — Run status
GET /v1/runs/{runId}/campaign — Run campaign graph
GET /v1/runs/{runId} — Run detail
POST /v1/runs/{runId}/publish — Publish draft run
GET /v1/runs/{runId}/table — Run table
POST /v1/posts/{postId}/retry — Retry post
POST /v1/posts/{postId}/delete — Delete provider post
DELETE /v1/posts/{postId} — Cancel post

Assets and Media Delivery

GET /v1/assets — List assets
POST /v1/assets/upload — Upload asset
POST /v1/assets — Register asset
DELETE /v1/assets/{assetId} — Delete asset
GET /media/{assetId}/{deliveryToken}/{filename} — Fetch media asset
GET /media/{assetId}/{deliveryToken}/previews/{filename} — Fetch media preview

Analytics

GET /v1/analytics/posts/{postId} — Post analytics
GET /v1/analytics/accounts/{accountId} — Account analytics
GET /v1/analytics/runs/{runId} — Run analytics
POST /v1/analytics/refresh — Refresh post analytics

Dashboard Browser API

GET /v1/dashboard/session — Dashboard session
POST /v1/support/request — Create support request
GET /v1/billing/state — Billing state
POST /v1/billing/checkout — Create checkout
POST /v1/billing/manage — Create billing portal
GET /v1/billing/app-store/account-token — App Store account token
GET /v1/billing/app-store/products — App Store products
POST /v1/billing/app-store/transactions/claim — Claim App Store transaction
GET /v1/dashboard/accounts — Dashboard accounts
DELETE /v1/dashboard/accounts/{accountId} — Dashboard disconnect account
GET /v1/dashboard/accounts/{accountId}/publish-settings — Dashboard publish settings
POST /v1/dashboard/connections/start — Dashboard start connection
GET /v1/dashboard/connections/{connectionId} — Dashboard connection status
GET /v1/dashboard/posts — Dashboard posts
POST /v1/dashboard/posts/{postId}/reconcile — Dashboard reconcile post
PATCH /v1/dashboard/posts/{postId} — Dashboard update post
DELETE /v1/dashboard/posts/{postId} — Dashboard delete post
GET /v1/dashboard/assets — Dashboard assets
DELETE /v1/dashboard/assets/{assetId} — Dashboard delete asset
POST /v1/dashboard/assets/upload — Dashboard base64 asset upload
POST /v1/dashboard/assets/upload/initiate — Dashboard multipart initiate
POST /v1/dashboard/assets/upload/{assetId}/part — Dashboard multipart sign part
POST /v1/dashboard/assets/upload/{assetId}/complete — Dashboard multipart complete
POST /v1/dashboard/assets/upload/{assetId}/abort — Dashboard multipart abort
POST /v1/dashboard/compose — Dashboard compose
GET /v1/dashboard/keys — Dashboard list keys
POST /v1/dashboard/keys — Dashboard create key
DELETE /v1/dashboard/keys/{keyId} — Dashboard revoke key
POST /v1/dashboard/keys/{keyId}/rotate — Dashboard rotate key

Auth, Billing, and Provider Callbacks

GET /auth/mobile/google/start — Mobile Google auth start
GET /auth/mobile/apple/start — Mobile Apple auth start
POST /auth/mobile/apple/native — Native Apple token exchange
POST /v1/billing/webhook — Billing webhook
POST /v1/billing/app-store/notifications — App Store server notification
POST /webhooks/meta/deauthorize — Meta deauthorize webhook
POST /webhooks/meta/data-deletion — Meta data deletion webhook