API overview
The Reignitor API lets your servers make videos. You send a brief or a scene plan, Reignitor renders the video, and you collect the finished MP4. It is the same render engine that runs Brand Flow in the app.
What you can do
Section titled “What you can do”- Make a video from a brief. Describe the advert or training video in plain language. Reignitor plans the scenes and renders them.
- Make a video from your own scene plan. Send the scenes yourself when you need full control over what each one shows and says.
- Brand every video. Name one of your brand kits, or send a logo and colours.
- Track renders. Poll a job until it finishes, or get a webhook when it does.
- Check your account. Confirm a key works and read your credit balance.
Base URL
Section titled “Base URL”https://reignitor.com/v1Webhook subscriptions live under https://reignitor.com/api/webhooks and use the same API key.
Requests and responses
Section titled “Requests and responses”- Send JSON with
Content-Type: application/json. - Every response is JSON, including errors.
- Renders run in the background. Starting one returns
202 Acceptedand ajob_idstraight away. - Call the API from your server. Never put an API key in a browser or mobile app.
Authentication
Section titled “Authentication”Every request needs an API key in the Authorization header:
Authorization: Bearer emp_...See Authentication for how to create and revoke keys.
Who has access
Section titled “Who has access”API access is part of the Agency plan. A key on any other plan is refused with
402 PLAN_UPGRADE_REQUIRED. See Account and billing to change plan.
Credits
Section titled “Credits”Renders spend your account’s credits, the same credits you use in the app. Every render
response tells you how many credits it used, and GET /v1/me returns your balance. Credit
costs depend on the length, scene count and quality of the video. See
Account and billing for how credits work.
Endpoints
Section titled “Endpoints”| Method | Path | What it does |
|---|---|---|
GET |
/v1/me |
The key’s account and credit balance |
POST |
/v1/render |
Start a render from a brief or a scene plan |
GET |
/v1/job/{id} |
Status of a render, and the video URL when done |
GET POST PATCH DELETE |
/api/webhooks/... |
Manage webhook subscriptions |
Next steps
Section titled “Next steps”- Quickstart: your first video in five steps.
- Making videos: briefs, scene plans, brands and products.
- Webhooks: get told when a video is ready.
- Errors and Limits.
- Endpoint reference: every field of every endpoint.