API reference
API reference
Every operation of the Relay Port API, generated from the OpenAPI document the API itself is built from.
Download the OpenAPI documentAPI facts
- Base URL
- https://api.relayport.dev
- Version
- 2026-12-01
- Format
- JSON, camelCase fields, RFC 3339 times
Authentication
- An API key: rp_live_... for live data or rp_test_... for test data. Any other bearer is 401 Unauthenticated.
- A signed-in Dashboard session (the relayport_at cookie). Session-only operations take only this; writes also need X-Requested-With.
Resources
- Accounts9 operationsConnected social accounts: connect, read, check, move between brands and disconnect.
- Connect links2 operationsHosted pages your customers open to connect their own accounts without a Dashboard login.
- Brands5 operationsBrands group accounts, posts, queues and media. A brand-restricted key sees only its brands.
- Posts11 operationsCreate, schedule, publish and follow posts, one target per connected account.
- Queues7 operationsWeekly posting times in one time zone; mode queue takes the earliest free slot.
- Media9 operationsImages and videos to attach to posts: direct upload, presigned upload or import from a URL.
- Platforms2 operationsThe platforms, their publishing rules and capabilities, and the planned platforms.
- Webhooks9 operationsSigned Standard Webhooks deliveries of the public events to your endpoints.
- Events3 operationsThe public event log, the same events the webhooks deliver.
- Usage2 operationsThe workspace's meters against its plan.
- API keys7 operationsScoped rp_live_ and rp_test_ keys and the log of the requests made to the workspace, managed from a signed-in session.
- Workspaces5 operationsThe workspaces a signed-in user belongs to and their product modules.
- Members3 operationsThe people in a workspace and their roles.
- Invites4 operationsEmail invites into a workspace.
- Billing1 operationThe plans and their prices.
- Feedback2 operationsVotes for planned platforms and modules.