API reference
Everything the editor does, you can do over HTTP: create projects, upload assets, render and download videos. All endpoints live under /api/v1.
Authentication
Send a workspace API key in the Authorization header on every request. Create keys in Settings → API Keys and choose their scopes; a key can only do what its scopes allow. API access is included on the Pro and Team plans.
Authorization: Bearer rs_your_api_key
Content-Type: application/jsonQuick start
Create a project, render it, and poll the render until it finishes. Renders run in the cloud, so the request returns straight away with a render id.
# 1. Create a project
curl -X POST https://rendersnap.io/api/v1/projects \
-H "Authorization: Bearer rs_your_api_key" \
-H "Content-Type: application/json" \
-d '{"name": "My first video"}'
# 2. Render it (use the project id from step 1)
curl -X POST https://rendersnap.io/api/v1/renders \
-H "Authorization: Bearer rs_your_api_key" \
-H "Content-Type: application/json" \
-d '{"projectId": "<project id>", "resolution": "1080p", "format": "mp4"}'
# 3. Check progress until status is "done", then download outputUrl
curl https://rendersnap.io/api/v1/renders/<render id> \
-H "Authorization: Bearer rs_your_api_key"Webhooks
Instead of polling, pass a webhookUrl when you submit a render. We POST a signed JSON payload (event render.done, with the outputUrl) to it when the render completes.
{
"projectId": "<project id>",
"format": "mp4",
"webhookUrl": "https://example.com/hooks/rendersnap"
}Motion graphics
Render animated counters, countdown timers and progress bars from your own numbers. Add a track whose kind is motion to a project's timeline, then render it like any other project. They are the same templates as the editor's Motion panel and the counter & progress maker, so you can design one there and copy its settings.
{
"settings": {
"width": 1920,
"height": 1080,
"fps": 30,
"backgroundColor": "#100c1f"
},
"duration": 5,
"tracks": [
{
"id": "track-1",
"kind": "motion",
"items": [
{
"id": "counter-1",
"kind": "motion",
"name": "Follower count",
"start": 0,
"duration": 5,
"x": 0.219,
"y": 0.32,
"w": 0.563,
"h": 0.36,
"opacity": 1,
"motion": {
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 2.5,
"template": "counter",
"style": "classic",
"from": 0,
"to": 12500,
"decimals": 0,
"prefix": "",
"suffix": "",
"separator": true,
"label": "Followers"
}
}
]
}
]
}Send it as timelineJson (a JSON string) when you create the project. Pass durationSeconds too: it is what your render minutes are counted from.
# Create the project (timelineJson is the timeline above, as a string)
curl -X POST https://rendersnap.io/api/v1/projects \
-H "Authorization: Bearer rs_your_api_key" \
-H "Content-Type: application/json" \
-d '{"name":"Follower counter","durationSeconds":5,"timelineJson":"{\"settings\":{\"width\":1920,\"height\":1080,\"fps\":30,\"backgroundColor\":\"#100c1f\"},\"duration\":5,\"tracks\":[{\"id\":\"track-1\",\"kind\":\"motion\",\"items\":[{\"id\":\"counter-1\",\"kind\":\"motion\",\"name\":\"Follower count\",\"start\":0,\"duration\":5,\"x\":0.219,\"y\":0.32,\"w\":0.563,\"h\":0.36,\"opacity\":1,\"motion\":{\"color\":\"#ffffff\",\"accentColor\":\"#7b5cff\",\"trackColor\":\"#26263a\",\"textColor\":\"#d4d4e0\",\"easing\":\"easeOut\",\"entrance\":\"pop\",\"animSeconds\":2.5,\"template\":\"counter\",\"style\":\"classic\",\"from\":0,\"to\":12500,\"decimals\":0,\"prefix\":\"\",\"suffix\":\"\",\"separator\":true,\"label\":\"Followers\"}}]}]}"}'
# Then render it, as in the quick start
curl -X POST https://rendersnap.io/api/v1/renders \
-H "Authorization: Bearer rs_your_api_key" \
-H "Content-Type: application/json" \
-d '{"projectId": "<project id>", "resolution": "1080p", "format": "mp4"}'The motion item
| Field | Type | What it does |
|---|---|---|
kind | "motion" | On a track whose kind is also "motion". |
start, duration | seconds | When the graphic is on screen. Its animation starts at its own start. |
x, y | 0–1 | Top-left corner of its box, as a fraction of the canvas. |
w, h | 0–1 | Box size, as a fraction of the canvas. Everything scales to fit the box. |
opacity | 0–1 | Optional, default 1. |
motion | object | What to draw: one of the three templates below. |
Look and animation (every template)
Every motion object has a template, a style and these fields. All of them are required; start from a template below and change what you need.
| Field | Type | What it does |
|---|---|---|
color, accentColor, trackColor, textColor | #rrggbb | Main colour, glow or gradient end, unfilled track and card faces, and labels. |
easing | enum | linear, easeOut, easeInOut, bounce or elastic. How the value travels. |
entrance | enum | none, fade, pop or slideUp. How the graphic arrives. |
animSeconds | seconds | How long the value takes to reach its end; it then holds. Not used by countdowns. |
template: "counter"styles: classic, neon, odometer, flip
| Field | Type | What it does |
|---|---|---|
from, to | number | Counts from one to the other. |
decimals | 0–3 | Digits after the point. |
prefix, suffix | string | Drawn around the number, e.g. "$" or "K+". |
separator | boolean | Group thousands: 12,500. |
label | string | Small line under the number. Empty for none. |
template: "countdown"styles: digital, ring, flip
| Field | Type | What it does |
|---|---|---|
seconds | 1–5999 | Counts down to zero in real time. Make the item at least this long. |
label | string | Small line under the clock. Empty for none. |
template: "progress"styles: linear, gradient, segmented, ring
| Field | Type | What it does |
|---|---|---|
from, to | 0–100 | Percent the bar fills from and to. |
label | string | Shown above the bar, or inside the ring. |
showPercent | boolean | Show the percent as it fills. |
segments | 3–40 | Blocks in the segmented style. |
Templates to start from
Each is a complete motion object. Paste one in and change the numbers.
Follower countCounts up with a pop
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 2.5,
"template": "counter",
"style": "classic",
"from": 0,
"to": 12500,
"decimals": 0,
"prefix": "",
"suffix": "",
"separator": true,
"label": "Followers"
}RevenueMoney that slides in
{
"color": "#4ade80",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeInOut",
"entrance": "slideUp",
"animSeconds": 2.5,
"template": "counter",
"style": "classic",
"from": 0,
"to": 250000,
"decimals": 0,
"prefix": "$",
"suffix": "",
"separator": true,
"label": "Revenue this year"
}OdometerRolling digit wheels
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 4,
"template": "counter",
"style": "odometer",
"from": 0,
"to": 98765,
"decimals": 0,
"prefix": "",
"suffix": "",
"separator": false,
"label": "Miles driven"
}Flip counterSplit-flap cards
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "linear",
"entrance": "fade",
"animSeconds": 3.5,
"template": "counter",
"style": "flip",
"from": 1990,
"to": 2026,
"decimals": 0,
"prefix": "",
"suffix": "",
"separator": false,
"label": ""
}NeonGlowing number
{
"color": "#67e8f9",
"accentColor": "#e879f9",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "counter",
"style": "neon",
"from": 0,
"to": 100,
"decimals": 0,
"prefix": "",
"suffix": "%",
"separator": true,
"label": ""
}RatingBounces to a score
{
"color": "#fbbf24",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "bounce",
"entrance": "pop",
"animSeconds": 2.5,
"template": "counter",
"style": "classic",
"from": 0,
"to": 4.9,
"decimals": 1,
"prefix": "",
"suffix": " / 5",
"separator": true,
"label": "Average rating"
}Digital timerCountdown in a pill
{
"color": "#ffffff",
"accentColor": "#f87171",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "countdown",
"style": "digital",
"seconds": 10,
"label": ""
}Ring timerA ring that drains
{
"color": "#ffffff",
"accentColor": "#f87171",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "countdown",
"style": "ring",
"seconds": 10,
"label": ""
}Flip clockFlip cards, minutes and seconds
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "countdown",
"style": "flip",
"seconds": 60,
"label": "Starting soon"
}Loading barFills with a percent
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 3,
"template": "progress",
"style": "linear",
"from": 0,
"to": 100,
"label": "Loading…",
"showPercent": true,
"segments": 10
}Goal trackerGradient bar with a shimmer
{
"color": "#7b5cff",
"accentColor": "#f472b6",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 3,
"template": "progress",
"style": "gradient",
"from": 0,
"to": 72,
"label": "Fundraising goal",
"showPercent": true,
"segments": 10
}SegmentedBlocks light up one by one
{
"color": "#4ade80",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "linear",
"entrance": "pop",
"animSeconds": 3,
"template": "progress",
"style": "segmented",
"from": 0,
"to": 80,
"label": "Battery",
"showPercent": true,
"segments": 10
}Ring progressCircular percent
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "pop",
"animSeconds": 3,
"template": "progress",
"style": "ring",
"from": 0,
"to": 65,
"label": "Complete",
"showPercent": true,
"segments": 10
}SnowfallGentle snow over your video
{
"color": "#ffffff",
"accentColor": "#7b5cff",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "particles",
"style": "snow",
"density": 1
}FireworksRockets that burst and fall
{
"color": "#ffd166",
"accentColor": "#ff6b6b",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "particles",
"style": "fireworks",
"density": 1
}ConfettiTumbling coloured paper
{
"color": "#f472b6",
"accentColor": "#facc15",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "particles",
"style": "confetti",
"density": 1
}Twinkle lightsSoft glowing lights
{
"color": "#ffd166",
"accentColor": "#ff9f43",
"trackColor": "#26263a",
"textColor": "#d4d4e0",
"easing": "easeOut",
"entrance": "fade",
"animSeconds": 2.5,
"template": "particles",
"style": "lights",
"density": 1
}Responses & errors
Every response is JSON with ok set to true or false. Successful calls put their result in data; failed ones return an error with a code (for example UNAUTHORIZED, NOT_FOUND, VALIDATION_ERROR or PLAN_LIMIT) and a readable message.
Auth
- getGet the authenticated user profileTry it
/users/me
API Keys
Workspace
Team
- getList workspace membersTry it
/workspaces/me/members - patchUpdate a member roleTry it
/workspaces/me/members/{uid} - deleteRemove a workspace memberTry it
/workspaces/me/members/{uid} - getList pending workspace invitesTry it
/workspaces/me/invites - postCreate and send a workspace inviteTry it
/workspaces/me/invites - deleteRevoke a pending inviteTry it
/workspaces/me/invites/{inviteId}
Projects
- getList workspace projectsTry it
/projects - postCreate a projectTry it
/projects - getGet a project with timeline JSONTry it
/projects/{id} - patchUpdate project metadata or timelineTry it
/projects/{id} - deleteArchive or permanently delete a projectTry it
/projects/{id} - getList collections (audiobooks, podcasts) with member countsTry it
/collections - getGet a collection with its projects in orderTry it
/collections/{id} - postRender every chapter of a collection, two at a timeTry it
/collections/{id}/renders - patchStop a collection's render run, or retry its failed chaptersTry it
/collections/{id}/renders - postApply one chapter's design, or a layout / saved template, to a collection's chaptersTry it
/collections/{id}/design - deleteUndo the last design copy (chapters edited since are left alone)Try it
/collections/{id}/design - getEpisode layouts: built-in layouts and saved templates usable for a collection's chaptersTry it
/layouts