Create and use your key
API Keys
Create a key in Settings → API → Keys, store it where your code runs, and send it with each request. Keys belong to your account, and you can turn one off at any time.
Create an API key
Creating a key takes under a minute. You need to be signed in, and your plan must include API access.
Open API Keys in settings
Sign in to Vidbyte, then go to Settings → API → Keys. The page lists every key on your account with its status, expiry, and when it was last used.
Select Create API key
Give the key a name you will recognize later, such as the app or machine that uses it. Under Advanced settings you can choose how long it lasts: 7 days, 30 days (the default), 90 days, 1 year, or never.
Copy the key right away
Vidbyte shows the full key only once, right after you create it. Copy it before you close the dialog; afterwards the list shows only a masked version that cannot be used to sign in.
Save it where your code runs
Store the key in an environment variable such as
VIDBYTE_API_KEY, or in your hosting provider's secret settings. Keep it out of browser code, public repositories, and shared examples.
Use your key
Sign the CLI in once with your key, or send it in the x-api-key header when you call the API yourself. Both use the same key and the same account balance.
Run login and paste your key when asked. The CLI checks the key with Vidbyte and saves it only if it works; whoami shows which account is active.
Sign in
vidbyte-cli login
vidbyte-cli whoamiPut the full key, which starts with vb_live_, in the x-api-key header of every request. Replace the placeholder below with your own key.
Authenticate a request
curl https://vidbyte-backend.onrender.com/api/v1/roadmaps/list \
-H "x-api-key: $VIDBYTE_API_KEY"Manage and replace keys
Everything about a key after you create it happens on the same Keys page. Turning a key off takes effect on the next request.
Disable — Turns a key off without deleting its history. A disabled key cannot be turned back on, so create a new key when you need access again.
Revoke — Permanently cancels a key. Use it when a key may have been seen by someone else.
Expiry — A key with a lifespan stops working on its expiry date. The Keys page shows when each key expires.
If a key leaks — Revoke it, create a new key, and update the app or machine that used the old one.