Video API
Make your brand's promo videos from your own code, with the same templates, minutes and credits as the editor.
The video API makes the same short promo videos as the editor and your site's Videos screen. You pick a template, give it your words and photos, and SiteBrite makes an MP4 in your brand's logo, web address and colors.
How it works
- Make a key in Dashboard › API. Owners and developers can make one, and the account needs a plan or credits. See Authentication.
- Pick a template.
GET /templateslists them with the names each one is filled in by. See Templates. - Start a render.
POST /renderswith the brand, the template and your words. See Renders. - Check on it with
GET /renders/{id}every few seconds. When itsstatusisready, itsurlis your video.
curl https://sitebrite.app/api/v1/renders \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"brand": "cm9x2brand0001",
"template": "quote-reel",
"ratio": "1x1",
"modifications": {
"quote": "They fixed our furnace the same afternoon. Honest people.",
"count": 214,
"label": "happy clients"
}
}'
The basics
- Every address in these docs starts with
https://sitebrite.app/api/v1. - Requests and replies are JSON, except photo uploads, which send the photo itself.
- The API is for your server. Never put a key in a web page or an app, where anyone could read it.
What it costs
A video made through the API costs the same as one made anywhere else:
- It uses your plan's server minutes first, counted per second.
- Past them, each minute is 10¢ from credits.
- The minutes and credits are checked before the video is made. If they don't cover it, the render isn't started and you get a
402. - A video that fails costs nothing.
GET /usage shows what's left this month. See Usage.
In these docs
- Authentication: keys and how to send them
- Templates: the videos you can make and what fills them
- Brands and photos: whose video it is, and your own photos
- Renders: making a video and getting it back
- Usage: minutes and credits
- Errors and limits: what can go wrong and how much you can do