API Keys

Create and manage long-lived API keys for the CLI and third-party integrations

API keys provide long-lived authentication tokens for programmatic access to the Video Toolbox API. They are ideal for CLI usage, CI/CD pipelines, and third-party integrations.

Creating API Keys

From the web interface

Go to Account > API Keys
Click Create Key
Enter a name for your key (e.g. "production", "ci", "local")
Copy the key immediately — it is only shown once

From the CLI

# Login first
videotoolbox-cli auth login --email [email protected] --password pass

# Create a key
videotoolbox-cli auth apikey create --name "production"

# Use the key
videotoolbox-cli auth set vtb_your_key_here

Key Properties

Property	Description
Name	A label to identify the key
Prefix	`vtb_` by default — helps identify the key type
Expiration	1 year by default
Rate Limit

CLI - Getting Started CLI Commands

API keys are sent as Bearer tokens in the Authorization header:

curl -H "Authorization: Bearer vtb_your_key_here" \
     -H "x-org-slug: your-org-slug" \
     https://your-app.com/api/cli/orgs/your-org/credits

Or with the CLI (automatically handled):

videotoolbox-cli auth set vtb_your_key_here
videotoolbox-cli org set your-org-slug
videotoolbox-cli credits balance

videotoolbox-cli auth apikey list

videotoolbox-cli auth apikey revoke --id key_id_here

From the web interface:

Go to Account > API Keys
Click the delete icon next to the key

Security Best Practices

Give each key a descriptive name (e.g. "github-actions", "local-dev")
Create separate keys for different environments
Revoke keys you no longer use
Never commit API keys to version control
Use environment variables to store keys in CI/CD

Product

Company

Legal

Product

Company

Legal

API Keys

Creating API Keys

From the web interface

From the CLI

Key Properties

Using API Keys

Managing Keys

List your keys

Revoke a key

Security Best Practices