View as Markdown

Endpoint reference

On this page

Base URL: https://public-api.robopost.app. Every endpoint needs an API key.

The complete, always current description of every endpoint, field and value is the OpenAPI document:

https://public-api.robopost.app/openapi.json: import it in Postman or Insomnia, or generate a client.
https://public-api.robopost.app/docs: browse it and try calls in the browser.

Posts

Method and path	Does	Guide
`POST /v1/scheduled_posts`	Create posts (one per channel) or a draft	Create posts
`GET /v1/scheduled_posts`	List posts, with filters and paging	List and read posts
`GET /v1/scheduled_posts/{id}`	One post, with its `ETag`	List and read posts
`PATCH /v1/scheduled_posts/{id}`	Edit, reschedule, unschedule, retry	Edit and delete posts
`DELETE /v1/scheduled_posts/{id}`	Delete, optionally on the network	Edit and delete posts
`GET /v1/scheduled_posts/changes`	Change feed	Changes and webhooks
`POST /v1/scheduled_posts/{id}/analytics/refresh`	Refresh a post's metrics	Analytics

Webhooks

Method and path	Does
`POST /v1/webhooks`	Add an endpoint (returns its secret)
`GET /v1/webhooks`, `GET /v1/webhooks/{id}`	List, read
`PATCH /v1/webhooks/{id}`	Change, enable, disable
`DELETE /v1/webhooks/{id}`	Remove
`POST /v1/webhooks/{id}/rotate_secret`	New secret
`POST /v1/webhooks/{id}/test`	Send a test event

Media, channels, collections

Method and path	Does	Guide
`POST /v1/medias/upload`	Upload an image or video	Media
`GET /v1/channels`	List channels	Channels and collections
`GET /v1/post_collections`	List collections	Channels and collections
`GET /v1/auth`	Check a key	Authentication

Method and path	Does
`GET /v1/social_inbox_items`	List comments and reviews
`GET /v1/social_inbox_items/threads`	Comments grouped by post
`GET /v1/social_inbox_items/{id}`	One item
`GET /v1/social_inbox_items/unread/count`, `/unread/by_channel`	Unread counts
`POST /v1/social_inbox_items/posts/{post id}/comments`	Comment on a post
`POST /v1/social_inbox_items/{id}/reply`	Reply to a comment
`DELETE /v1/social_inbox_items/posts/{post id}/comments/{id}`	Delete a comment
`PATCH /v1/social_inbox_items/{id}`	Mark read or unread
`GET /v1/social_inbox_items/channels/{channel id}/gmb/threads`	Google reviews of a channel
`POST /v1/social_inbox_items/channels/{channel id}/gmb/reviews/{external id}/reply`	Reply to a review

Guide: Social inbox.

Analytics

Method and path	Does
`GET /v1/analytics/channels`	Totals per channel for a date range
`GET /v1/analytics/timeseries`	Metrics per day, week or month
`GET /v1/aggregated_posts_analytics`, `/{id}`	Team totals by network and period

Guide: Analytics.

AI video

Method and path	Does
`POST /v1/video-series`, `GET /v1/video-series`, `GET`/`PUT`/`DELETE /v1/video-series/{id}`	Manage series
`POST /v1/video-tasks/{series id}/generate`	Start a video
`GET /v1/video-tasks`, `GET /v1/video-tasks/{id}`, `GET /v1/video-tasks/{id}/details`, `DELETE /v1/video-tasks/{id}`	Follow and manage tasks

Guide: Video series.