API reference
Platforms
The platforms, their publishing rules and capabilities, and the planned platforms.
GET/platforms
List the platforms
Live platforms with their publishing rules and capabilities, and planned platforms (availability planned, with the release they are planned for and the interest key to vote with). No credentials needed.
curl https://api.relayport.dev/platformsParameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01
Responses
200OK
dataPlatform[]requiredaccountTypestringrequiredproviderstringrequirednamestringrequireddescriptionstringrequiredavailabilitystringrequiredOne of
liveplannedreleaseinteger | nullrequiredThe planned release of a coming platform; null when live
interestKeystring | nullrequiredtestbooleanrequiredtrue for test platforms such as sandbox, which only test keys see
variantsstring[]requiredrulesmap of any | nullrequiredThe publishing rules: caption limits, content types, media specs, timing and rate budgets; null for a planned platform
capabilitiesobject[]requiredkeystringrequiredOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststagestringrequiredOne of
gabetaplannedunsupportedvariantsstring[]requiredscopesstring[]requiredplanFeaturestringlimitsmap of numbernotestring
GET/platforms/{platform}
Get a platform
curl https://api.relayport.dev/platforms/{platform}Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01platformstringpathrequired
Responses
200OK
dataPlatformrequiredaccountTypestringrequiredproviderstringrequirednamestringrequireddescriptionstringrequiredavailabilitystringrequiredOne of
liveplannedreleaseinteger | nullrequiredThe planned release of a coming platform; null when live
interestKeystring | nullrequiredtestbooleanrequiredtrue for test platforms such as sandbox, which only test keys see
variantsstring[]requiredrulesmap of any | nullrequiredThe publishing rules: caption limits, content types, media specs, timing and rate budgets; null for a planned platform
capabilitiesobject[]requiredkeystringrequiredOne of
publishing.imagepublishing.carouselpublishing.reelpublishing.storypublishing.collaboratorspublishing.alt_textpublishing.user_tagspublishing.locationpublishing.trial_reelspublishing.ai_labelpublishing.first_commentpublishing.deletepublishing.resumable_uploadpublishing.partnership_labelpublishing.pollspublishing.audioinbox.comments.readinbox.mentionsinbox.dm.sendinbox.private_replyanalytics.post_metricsanalytics.account_metricsanalytics.story_insights_webhookads.booststagestringrequiredOne of
gabetaplannedunsupportedvariantsstring[]requiredscopesstring[]requiredplanFeaturestringlimitsmap of numbernotestring