- Overview
- MCP
- Platforms
- User Auth
- Users
- Get current user profile
- Update current user profile
- Get all user settings
- Update publishing settings
- Update notification settings
- Update UI preferences
- Get current billing usage
- List saved payment methods
- List billing transactions
- Regenerate API key
- Mark onboarding complete
- Create a new user and get API key
- Unregister a device from push notifications
- Get list of registered devices
- Register a device for push notifications
- Send a test push notification to the current user
- Remove the profile picture
- Upload a profile picture. Stored in the avatars folder, served via the
- Delete a payment method
- Set a payment method as default
- Download the invoice/receipt PDF for a captured (succeeded) transaction
- Social Accounts
- Get OAuth authorization URL
- List connected social accounts
- Disconnect a social account
- Get creator info for an account
- List available Facebook Pages
- Connect a Facebook Page
- List connected Facebook Pages for a workspace
- List available LinkedIn organizations
- Connect a LinkedIn organization
- List a Pinterest account's boards
- Create a new Pinterest board for the connected account
- Validate TikTok creator info
- Preview the scheduled posts that would be cancelled if this account is
- Workspaces
- Team
- List available permission scopes
- List pending invitations for the current user
- Get invitation details by token
- Accept a workspace invitation
- Decline a workspace invitation
- List workspace members
- Invite a user to the workspace
- List pending invitations for a workspace
- Cancel / revoke an invitation
- Resend an invitation email
- Update member role / scopes
- Remove a member from the workspace
- Leave a workspace
- Upload a single chat attachment (≤5 MB) to S3 and return { name, url, fileType }
- Channels the user can see: all workspace channels + DMs they're a member of
- Create a channel or DM
- /
- /
- /
- /
- Get groups
- Create groups
- Delete groupId
- Update groupId
- Get roles
- Create roles
- Delete roleId
- Update roleId
- Posts
- List posts
- Create a post
- List upcoming scheduled posts
- Delete multiple posts
- Get a post
- Update a post
- Delete a post
- Get analytics for a post
- Reschedule a post
- Retry a failed post
- Cancel a scheduled post
- Publish a draft post
- Submit a post for approval
- Record an approval decision
- Get post version history
- Rich, board-ready view of everything in the approval pipeline for the
- All posts belonging to one Bulk Scheduler batch, in schedule order
- Summaries of every batch created by the Bulk Scheduler in this workspace —
- Create bulk
- Aggregated dashboard metrics computed across ALL posts in the workspace
- Ping the pending approvers of the post's current open stage
- /
- Body: { body, mentions?: [userId], attachments? }
- /
- /
- Deliberately release a 'ready' post (an immediate post that has cleared
- Assets
- List assets
- Bulk delete assets
- Upload asset directly (multipart)
- Get signed upload URL (step 1 of 2)
- Confirm signed upload (step 2 of 2)
- Get storage usage summary
- List asset folders
- Create a folder
- Rename a folder
- Delete a folder
- List asset tags
- Check thumbnail generation status
- Get an asset
- Update asset metadata
- Delete an asset
- Batch-resolve asset metadata (name, type, url, thumbnail) for a list of IDs
- Uploads
- Analytics
- Get platform aggregate stats
- Get platform stats as a time series
- Get audience demographics for a platform
- List content analytics for a platform
- Get analytics for a specific content item
- Delete a synced content record
- Get time series for a specific content item
- Get follower count trend over time
- Get recommended posting times per platform
- Get aggregated analytics for a post across platforms
- Gather data → render HTML → print to PDF (Puppeteer) → stream as a download
- Generate the AI analysis on demand so the builder can preview it before export
- For the report builder: gathers (and caches) the data, then returns the list of
- Renders the analytics report as a self-contained HTML page so the template
- Streams
- List streams
- Create a stream
- Get a stream
- Delete a stream
- Go live
- Stop a live stream
- Broadcast from a file
- Update a stream
- Check relay health and list active paths
- Get relay status for a specific stream
- Get streaming usage for the authenticated user (minutes, limits, active streams)
- the relay (path + token) and re-arm fan-out, returning the WHIP URL so
- Plans
- Subscriptions
- Support
- AI
- Studio
- Payments
- Pay for a purchase with wallet credit
- Charge a saved payment method (for recurring subscriptions or credit purchases)
- Get payment configuration for frontend (public key, supported currencies, etc.)
- Create cryptocurrency payment invoice via Heleket
- Initialize a payment (subscription or credit purchase)
- Verify a payment
- Bluesky OAuth
- Apps
- Billing
- Get user's billing cycles (all statuses for full history)
- Calculate proration for upgrading cycles (no charge, just preview)
- Manually create billing cycles from an existing transaction (admin/fix tool)
- Select a plan after account creation (for free plans or initial plan selection)
- Upgrade billing cycles to a new plan with proration
- Preview the discount a coupon yields for a subscription checkout, so the
- Blog
- Books
- Platforms
- Ideas
- Notifications
- Queue
- Limits
- Services
- Approvals
- Schemas
Subscription
{
"plan": {
"_id": "string",
"name": "string",
"limits": {
"creditsPerMonth": 0,
"storageBytes": 0,
"workspaces": 0
},
"features": {},
"prices": [
{
"currency": "string",
"amount": 0,
"interval": "string"
}
],
"isDefault": true,
"isActive": true
},
"credits": {
"subscription": 0,
"purchased": 0,
"total": 0,
"unlimited": true
},
"creditsResetAt": "2019-08-24T14:15:22.123Z",
"subscriptionStatus": "active",
"subscriptionEndsAt": "2019-08-24T14:15:22.123Z",
"storageUsedBytes": 0,
"autoRenew": true,
"extraAccounts": 0,
"maxAccounts": 0,
"termMonths": 0,
"nextTermMonths": 0,
"wallet": {
"NGN": 5000,
"USD": 12.5
}
}