REST API
LiveRenderly's REST API gives you full programmatic control over video rendering. Create renders from your projects or system templates, pass dynamic replacement values, track render progress, and receive webhook notifications — all through simple HTTP endpoints. Authenticate with an API key, send JSON payloads, and integrate video generation into any application, backend service, or CI/CD pipeline.
Triggers & Actions
Events that start your workflow and actions you can automate with REST API.
Create Render
POST to /api/v1/renders with a project ID or template ID and dynamic replacements. Returns a job ID for tracking. Supports custom dimensions, FPS, and webhook callbacks.
Get Render Status
GET /api/v1/renders/:jobId to check progress, status, output URL, file size, and credits consumed. Poll or use webhooks for async updates.
List Templates
GET /api/v1/templates returns all public system templates with their available dynamic variables, categories, and default values.
Webhook Events
Register webhook endpoints via POST /api/v1/webhooks to receive real-time render.completed and render.failed events. Payloads are signed with HMAC-SHA256.
How It Works
Get up and running with REST API in a few simple steps.
Generate an API key
Go to your Renderly dashboard → Settings → API Keys. Create a new key and store it securely. You'll include this in the Authorization header of every request.
Choose your endpoint
Decide what you want to do: create a render (/api/v1/renders), check status (/api/v1/renders/:jobId), list templates (/api/v1/templates), or manage webhooks (/api/v1/webhooks).
Send your first request
Make an HTTP request with your API key in the Authorization header as "Bearer <your-key>". For render creation, send a JSON body with your project ID and any replacement values.
Handle the response
Successful render requests return a job ID and initial status. Store the job ID to track progress. The response also includes estimated credits used.
Set up webhooks for async results
Register a webhook URL to receive notifications when renders complete or fail. Alternatively, pass a webhookUrl directly in the render request for one-off callbacks. Verify payloads using the HMAC-SHA256 signature.
Example Workflow
Add video rendering to your SaaS onboarding
When a new user completes onboarding, your backend calls Renderly's API to generate a personalized tutorial video, then delivers it via email.
- 1User completes your onboarding flow and your backend fires an event
- 2Your server calls POST /api/v1/renders with the user's name, plan type, and avatar as replacements
- 3Renderly queues the render and returns a job ID
- 4Your webhook endpoint receives the render.completed event with the video URL
- 5Your server sends the personalized video to the user via email or in-app notification
Frequently Asked Questions
Quick answers about setup, billing, and troubleshooting.
