API reference
Every operation of the Siar REST API (263 in version 1.0.0), generated from the OpenAPI document that the server itself runs on.
Base URL: https://api.siaran.my/api/v1. Authenticate every request with your organization API key in the x-api-key header. The machine-readable contract is at /openapi.json; the SDK, CLI and MCP server are generated from the same document.
curl "https://api.siaran.my/api/v1/team" -H "x-api-key: $SIAR_API_KEY"Everything in this reference is read from the contract at build time, so it cannot drift from what the server accepts. Request bodies are validated against these schemas before any handler runs; a mismatch returns 400 with an issues array that points at the offending field.
Posts
Create, schedule, update, retry and delete posts. One post targets several networks at once through its per-network data.
9 operationsUploads
Store media once and reference the upload id from any number of posts. Simple, from-URL, large (signed PUT) and multipart uploads.
12 operationsSocial accounts
Connect, disconnect and inspect social accounts; pick channels; create hosted connect links for your own users.
13 operationsTeams
Teams (social sets) group at most one account per network. Create one team per customer, brand or location.
5 operationsComments
Publish comments and replies, import the comments people left on your posts and moderate them.
11 operationsAnalytics
Post and account metrics, normalised across networks, with the raw network payload kept alongside.
7 operationsPost history import
Backfill posts that were published outside Siar, optionally with their analytics.
6 operationsCSV import
Create many posts at once from a CSV file and follow the result row by row.
5 operationsWebhooks
Subscribe an HTTPS endpoint to events, inspect deliveries, resend and rotate the signing secret.
9 operationsAPI keys
Create, roll and delete organization API keys. A new key is shown once.
4 operationsOrganization
The organization, its settings, its usage against plan quotas and its activity log.
10 operationsX credit
Read the prepaid balance that pays for X API usage and quote an X action before running it.
2 operationsNetwork-specific
Operations that exist on one network only: playlists, boards, flairs, music libraries, Business Profile location data, reviews and more.
90 operationsConversations
Direct-message inboxes for networks that allow it through their API.
10 operationsAutomations
Flows that react to comments and messages, with executions you can inspect.
17 operationsBots
Display identities (name and avatar) used when Siar posts to Discord and Slack.
4 operationsBio pages
Hosted link-in-bio pages.
5 operationsBio items
Links and blocks on a bio page.
4 operationsBio analytics
Views and clicks of a bio page.
1 operationUsers
Your profile, organization members and invitations.
11 operationsNotifications
In-app notifications for the signed-in user.
3 operationsBilling
Plan, checkout, invoices and X credit top-ups.
12 operationsDashboard sessions
Sign-up and session endpoints used by the dashboard. Integrations use API keys instead.
9 operationsHosted portal
Endpoints behind the hosted connect page. They authenticate with the portal token in the path.
3 operationsHealth
A health check that needs no key.
1 operation