Help
Create an API key (then see the API docs)
An API key is a secret password that lets your own server or automation make videos and pictures on your Reviral account without opening the website. You create keys yourself on the API keys page (/app/api-keys); there is nothing to request. Once you have a key, everything else (requests, models, webhooks) is in the API documentation.
Updated · View as Markdown
Steps
- Open API keys. Sign in, then press API keys in the Account part of the left menu. The page is headed "API keys." and says "Create a key for your server or automation. You will see each new key only once, so copy it before leaving this page."
- Name the key. Under Create a new key (it shows "{n}/10 active"), type a name such as "Production server". Use up to 80 letters, numbers, spaces or
. _ ( ) -. - Create it. Press Create key.
- Copy it now. A box says "Copy this key now. It will not be shown again." Press Copy key (it turns into "Copied") and store the key somewhere safe, such as your server's settings.
- Use it. Keep the key on your server and send it as a Bearer token (a header your code adds to each request:
Authorization: Bearer <your key>). Never put it in browser code. Start with the API quickstart and authentication. - Revoke a key you no longer trust. Under Your keys, press Revoke next to it. It stops working and is marked "Revoked".
At a glance
| Item | Value |
|---|---|
| Where | API keys, /app/api-keys (signed in) |
| Who | Any signed-in account; no request needed |
| Active keys | Up to 10 |
| Key name | Up to 80 letters, numbers, spaces or . _ ( ) - |
| Shown | Once, at creation |
| Cost of a key | Free; API calls spend credits from your balance |
| Developer docs | /docs/api, plus credits and pricing, rate limits, errors |
Troubleshooting
| Message | What to do |
|---|---|
| "Enter a name for this key." | Type a name, then press Create key. |
| "You already have 10 active keys. Revoke one before creating another." | Revoke a key you don't use. |
| "You have created too many keys recently. Wait and try again." | Wait a while, then try again. |
| "Use up to 80 letters, numbers, spaces, or . _ ( ) - in the name." | Remove other symbols from the name. |
| "Copy failed. Select the key text above and copy it manually." | Select the key with your mouse and copy it before leaving the page. |
For anything the API docs don't answer, contact our support team. See plans and prices for credits.
FAQ
Do I need to ask for API access?
No. Any signed-in account can create keys itself on the API keys page; there is no waiting list.
How many API keys can I have?
Up to 10 active keys. Revoke one to make room for a new one.
I lost my key. Can I see it again?
No, a key is shown only once. Revoke the lost key and create a new one.
What does an API call cost?
API calls spend the same credits as your account balance. See the API docs pages on credits and pricing for each model's price.