19 endpoints under https://api.ravenpo.st/v1. Every one delegates to the same service the dashboard calls, so there is exactly one implementation of “create a post” and no second set of rules. Authentication is a bearer token; no route takes a workspace id, because the token carries one.
Conventions
Send Authorization: Bearer rvp_… on every request, and Content-Type: application/json on anything with a body.
Ids are opaque strings. Timestamps are ISO 8601 in UTC; queue slots and send-time recommendations are in the workspace timezone, with weekday 0 = Sunday.
Rate limit: 120 requests/minute per IP unless an endpoint says otherwise.
The token’s workspace, its plan limits, current usage and account counts.
The cheapest call to verify a token works. No endpoint takes a workspace id — the token carries exactly one, so a token can never reach another tenant’s data whatever the caller sends.
Without `page` this returns a plain array, matching the dashboard’s contract; with `page` it returns a paginated envelope. Automations should always pass `page` — a workspace with thousands of posts otherwise returns all of them in one response.
Field
In
Type
Description
status
query
DRAFT | SCHEDULED | PUBLISHING | PUBLISHED | FAILED
Filter by status.
platform
query
string
Only posts targeting this platform.
type
query
string
Filter by post format.
q
query
string
Caption search.
sort
query
string
Sort order.
page
query
number
Page number — switches the response to an envelope.
limit
query
number
Page size.
POST/v1/posts
Create a post and publish, schedule, queue or save it as a draft.
One post, many destinations: each account in `accountIds` becomes a target with its own status, permalink and error. Caption length is validated against the tightest selected platform.
Field
In
Type
Description
type*
body
'IMAGE' | 'CAROUSEL' | 'REEL' | 'STORY'
Post format. Instagram's model, reused as the shared one — a platform that doesn't honour the format falls back to its own default rather than failing.
accountIds*
body
string[]
Destination accounts, from GET /v1/accounts. One post fans out to all of them.
mediaIds*
body
string[]
Media assets to attach. Pass [] for a text-only post where the platform allows it.
action*
body
'draft' | 'now' | 'schedule' | 'queue'
What to do with it. 'schedule' needs scheduledAt; 'queue' resolves the next free slot in the workspace posting schedule and fails if none is configured.
caption
body
string
Base caption, used by every platform without an override.
captionOverrides
body
Record<Platform, string>
Per-platform caption. A platform with no entry publishes the base caption. Keys are platform ids from GET /v1/platforms.
scheduledAt
body
string (ISO 8601)
When to publish, for action: 'schedule'.
threadParts
body
string[]
Follow-up posts published in order after the head, on platforms that declare a thread model (X, Bluesky, Mastodon, Threads, Telegram, Discord). Over the platform limit is rejected, never truncated.
firstComment
body
string
Posted as the first comment after publishing. Instagram only.
replyToTweetId
body
string
Publish the head post as a reply under this tweet. Accepts an id or a tweet URL. X only.
quoteTweetId
body
string
Embed this tweet as a quote card. Id or URL. X only, and independent of replyToTweetId.
tiktokOptions
body
Record<accountId, object>
TikTok privacy level, interaction switches and commercial disclosure, keyed by account id. Omitted, a TikTok target publishes SELF_ONLY — TikTok requires the creator to choose, so we never pick a wider audience for them.
audio
body
object
Reel audio ({ audioId, audioVolume, videoVolume }). Instagram reels only, and only on an account connected through Facebook.
recurrence
body
object
Makes this an evergreen post: each occurrence is created after the previous one publishes.
Returns a per-line report so a caller can retry only the rows that failed, rather than guessing which half of the batch landed.
Field
In
Type
Description
csv*
body
string
The CSV document itself, as a string.
GET/v1/posts/:id
One post with every target’s status, permalink and error.
Field
In
Type
Description
id*
path
string
Post id.
PATCH/v1/posts/:id
Edit a draft or scheduled post.
Editing resets the post to draft — pass `action` in the same call to re-schedule or publish it. A published post cannot be edited.
Field
In
Type
Description
id*
path
string
Post id.
type
body
'IMAGE' | 'CAROUSEL' | 'REEL' | 'STORY'
Post format. Instagram's model, reused as the shared one — a platform that doesn't honour the format falls back to its own default rather than failing.
accountIds
body
string[]
Destination accounts, from GET /v1/accounts. One post fans out to all of them.
mediaIds
body
string[]
Media assets to attach. Pass [] for a text-only post where the platform allows it.
action
body
'draft' | 'now' | 'schedule' | 'queue'
What to do with it. 'schedule' needs scheduledAt; 'queue' resolves the next free slot in the workspace posting schedule and fails if none is configured.
caption
body
string
Base caption, used by every platform without an override.
captionOverrides
body
Record<Platform, string>
Per-platform caption. A platform with no entry publishes the base caption. Keys are platform ids from GET /v1/platforms.
scheduledAt
body
string (ISO 8601)
When to publish, for action: 'schedule'.
threadParts
body
string[]
Follow-up posts published in order after the head, on platforms that declare a thread model (X, Bluesky, Mastodon, Threads, Telegram, Discord). Over the platform limit is rejected, never truncated.
firstComment
body
string
Posted as the first comment after publishing. Instagram only.
replyToTweetId
body
string
Publish the head post as a reply under this tweet. Accepts an id or a tweet URL. X only.
quoteTweetId
body
string
Embed this tweet as a quote card. Id or URL. X only, and independent of replyToTweetId.
tiktokOptions
body
Record<accountId, object>
TikTok privacy level, interaction switches and commercial disclosure, keyed by account id. Omitted, a TikTok target publishes SELF_ONLY — TikTok requires the creator to choose, so we never pick a wider audience for them.
audio
body
object
Reel audio ({ audioId, audioVolume, videoVolume }). Instagram reels only, and only on an account connected through Facebook.
recurrence
body
object
Makes this an evergreen post: each occurrence is created after the previous one publishes.
DELETE/v1/posts/:id
Delete the Ravenpost copy and cancel any pending publish.
This does not take down anything already published. Removing the post on the platform is a separate, opt-in action in the dashboard, and three platforms (Instagram, Threads, TikTok) expose no delete endpoint at all.
Field
In
Type
Description
id*
path
string
Post id.
POST/v1/posts/:id/schedule
Move a post to a new time.
Field
In
Type
Description
id*
path
string
Post id.
scheduledAt*
body
string (ISO 8601)
New publish time.
POST/v1/posts/:id/publish
Publish a post immediately, whatever it was scheduled for.
Field
In
Type
Description
id*
path
string
Post id.
POST/v1/posts/:id/retry
Re-enqueue only the failed targets.
Targets that already published are left alone, so a retry can’t double-post.
Field
In
Type
Description
id*
path
string
Post id.
Media
GET/v1/media
The workspace media library.
Field
In
Type
Description
folderId
query
string
Limit to one folder.
POST/v1/media/uploads60/min
Step 1 of an upload: get a presigned PUT URL.
The client sends the bytes straight to object storage, so a large video never travels through the API — and never has to be base64-encoded into a request.
Field
In
Type
Description
filename*
body
string
Original filename, used for a readable storage key.
Step 2 of an upload: register the uploaded object as an asset.
Returns the asset `id` to put in `mediaIds`.
Field
In
Type
Description
type*
body
'IMAGE' | 'VIDEO'
Asset kind.
storageKey*
body
string
From the presign response.
url*
body
string
Public URL, from the presign response.
mimeType
body
string
Recorded for the per-platform compatibility check.
width
body
number
Pixels.
height
body
number
Pixels.
durationSec
body
number
Video length.
sizeBytes
body
number
File size, checked against each platform’s cap.
POST/v1/media/:id/variants30/min
Reshape one image into several platform canvases in a single call.
Cropping is saliency-based by default — an off-centre subject survives a 4:5 → 9:16 cut, where a centre crop would keep the wall behind them. Pass `crop: "centre"` for posters, screenshots and flat graphics composed around their middle. Two formats with the same dimensions produce one file, not two, and each variant inherits the source’s alt text and folder. Images only.
Followers per account, a 30-day daily series, and engagement on recent posts.
A `followers` of `null` means the platform reports none — LinkedIn, Threads and Discord expose no insights and TikTok’s need a scope that is not approved yet. Null means unknown, never zero; an absent post metric was not collected rather than being 0.
GET/v1/best-times
Recommended posting hours, measured from this workspace’s own posts.
Overall and per platform, in the workspace timezone. `score` is a multiple of a typical post for that account, so 1.8 means “roughly 80% better than normal”. When `insufficient` is true there is not enough history and `slots` is empty — that is “unknown”, not “no good time”; `observations` and `minObservations` say how far off it is.
The weekly posting schedule that `action: "queue"` publishes into.
Workspace-wide and shared by every connected account, in the workspace timezone. weekday 0 = Sunday.
GET/v1/platforms
Per-platform caption budgets, media rules, formats, thread caps and recommended specs.
Read this instead of hardcoding limits: they change when a platform changes, and this endpoint is generated from the same registry the publisher enforces.
OpenAPI
The same surface as a machine-readable document, generated from the source this page renders: /docs/openapi.json. Request bodies are documented by example rather than a strict schema — the examples are real, and a schema we hadn’t verified field by field would be a more confident kind of wrong.