An AI Video Generator API for Full Render Workflows
Reviral provides API-key authentication for submitting full video renders from a backend or automation. The current surface also exposes account and credit information, cost references and estimates, media search, and avatar-based character records. It is an active v1 surface, not a promise of a complete white-label platform or standalone asset API.
- v1
- current API
- Bearer
- key authentication
- Full
- video render workflow
Implemented, not aspirational
What Can the Reviral API Do Today?
A server can authenticate with a Reviral API key and submit a full video render through POST /api/v1/render. The request is validated by the same render-start path used by the product. Supported values include prompt, script, article, static-background, caption, product-ad, UGC-ad, music, motion-transfer, audio, quiz, and lyrics-oriented paths, subject to each workflow's required fields and current account access.
The v1 surface also provides account and credit information, a public credit-cost reference, a no-charge render-cost estimate, media search, and avatar-based character records. GET /api/v1/render returns a public JSON document describing the POST endpoint, authentication headers, workflow and field metadata, pricing metadata, response examples, rate-limit metadata, versions, and build date. Generate, list, and revoke named keys from /app/api-keys.
The honest surface map
Current v1 Endpoint Status
Use only endpoints that have a working handler today, and treat documented contracts that return 501 as unavailable.
| Endpoint | Current behavior | Authentication |
|---|---|---|
| GET /api/v1/render | Returns JSON documentation metadata for POST /api/v1/render | Public |
| POST /api/v1/render | Submits a full render through the shared render-start path | API key |
| GET /api/v1/me | Returns the key owner's plan and credit balance | API key |
| GET /api/v1/credit-costs | Returns the current credit reference | Public |
| POST /api/v1/calculate-credits | Estimates a render before submission | Public |
| POST /api/v1/media-search | Searches curated media by natural-language query | API key |
| GET, POST, DELETE /api/v1/characters | Lists, creates, reads, or soft-deletes avatar records | API key |
| POST /api/v1/generate-media | Standalone asset contract exists but returns 501 | API key |
The GET document describes the POST contract but does not prove that every route or field in its examples is implemented. Use this surface map and test non-production requests before depending on an endpoint.
Four backend steps
How Do You Start with the Reviral Video API?
Keep API keys on the server and validate one short workflow before building a larger automation.
- 01
Create a named key
Open /app/api-keys, generate a key for one environment, copy it once, and store it as a server-side secret.
- 02
Inspect the JSON document
Call GET /api/v1/render to inspect its POST endpoint metadata, then use the implemented surface table on this page to choose supported routes.
- 03
Estimate the credits
Send the planned tier, media type, duration, preset, and variant count to /api/v1/calculate-credits before submission.
- 04
Submit one controlled render
Call POST /api/v1/render with the API key and a small validated request, then confirm the returned project in your Reviral account.
Server-side credentials only
How Should You Handle API Keys?
A Reviral key is shown once when it is created. Store it in a secret manager or protected server environment, never in browser code, a public repository, a mobile bundle, or a customer-visible log. Use a different named key for production, staging, and local development so one environment can be revoked without stopping the others.
The key page displays prefixes, creation dates, last-used dates when available, and revoked status. Revoke a key immediately when it is exposed or no longer needed. Do not share one key across unrelated clients; separate names and storage make incident response and usage review clearer.
Known v1 limits
What Is Not Available Yet?
Do not build against POST /api/v1/generate-media for standalone images or short clips; its request contract exists, but the handler currently returns 501. The GET /api/v1/render document includes a statusUrl example for /api/v1/projects/<projectId>, but that public project-status handler does not exist. It also documents webhookUrl, but POST /api/v1/render does not consume a customer-supplied webhookUrl. Track jobs and confirm completed work inside the Reviral account until supported status and callback contracts exist.
The API is not a turnkey white-label agency portal. It does not create client subaccounts, custom domains, reseller billing, or agency seat roles. It is best used as a server-side render and account-control surface inside an automation your team owns.
Four citable answers
AI Video Generator API FAQs
Does Reviral have a real video generation API?+
Yes. POST /api/v1/render authenticates a Reviral API key and forwards the submitted body into the same validated render-start path used by the product. It is intended for full video workflows rather than a single standalone image or clip. GET /api/v1/render returns public JSON documentation metadata for that POST endpoint; use the implemented surface table on this page and test one small request before production automation.
Where do I create a Reviral API key?+
Create keys at /app/api-keys after signing in. Give each environment or integration a clear name. The full secret is displayed once, while the page later shows its prefix and status. Store the key only in a protected backend or secret manager. The same page lets you revoke an active key without deleting your Reviral account.
Can I estimate credits before submitting a render?+
Yes. POST /api/v1/calculate-credits accepts a render configuration and returns an estimated credit total without authentication, consuming credits, or writing a render job. GET /api/v1/credit-costs provides the broader action-based rate reference. Estimates should be treated as preflight guidance; compare them with the final product display and account balance before scheduling a large batch.
Can the API generate a single image or short clip?+
Not through the standalone endpoint today. POST /api/v1/generate-media validates the planned request shape but returns HTTP 501 because that pipeline is not implemented. Use the working full-render endpoint only for supported workflows, and do not market the standalone contract as available. Check the implemented endpoint table and handler status before revisiting that integration in a future release.
Start from live surfaces
Useful API and Pricing Routes
Continue with the live account, pricing, or agency surface needed for your integration.
Authenticated account page
Create a Key and Test from Your Backend
Generate a named key, copy it when it is shown, and store it in your server-side secret manager. The key page also lists active keys and lets you revoke them.
Manage API keysLast updated: August 16, 2026