VitePress

Appearance

The Socifyr REST API is the foundation everything sits on. Use it from any language.

Base URL ​

https://api.socifyr.com/api

For self-hosted: whatever you've deployed.

Authentication ​

Send an API key in the Authorization header and a workspace ID in X-Workspace-Id:

http
Authorization: Bearer sk_4b73...
X-Workspace-Id: 69fbbf978e770da397a59a5a

See Authentication.

Response envelope ​

Every response is wrapped:

json
{
  "success": true,
  "data": <result>
}

Errors:

json
{
  "success": false,
  "error": "Connection \"nonexistent-slug\" not found",
  "statusCode": 400,
  "path": "/api/content/text",
  "timestamp": "2026-04-19T..."
}

For validation failures, error is an array of strings:

json
{
  "success": false,
  "error": [
    "connections should not be empty",
    "text must be a string"
  ],
  "statusCode": 400
}

Sections ​

  • Content — Publish, list, retry, schedule, archive posts
  • Media — Upload and manage library files
  • Analytics — Engagement metrics and summaries
  • AI — Caption generation, hashtag suggestions
  • Webhooks — Push event endpoints
  • Workspaces — Members, invitations, API keys, connections

Rate limits ​

  • Default: 60 requests / minute per API key
  • Burst: up to 10 requests in 1 second
  • 429 response: includes Retry-After header in seconds

Higher limits available on Business tier.

Versioning ​

The API is unversioned today. Breaking changes are introduced via new endpoints, never by modifying existing ones. Watch the changelog for additions.