Skip to main content

API Key Format

All API requests require authentication using an API key with the format vbr_ followed by 32 characters.

Request Header

Include your API key in the X-Api-Key header for all requests:
Never share your API key publicly or include it in client-side code. Keep it secure on your server.

Getting Your API Key

1

Create an account

Sign up at videobgremover.com if you haven’t already.
2

Generate API key

Go to API Management and create a new API key with a descriptive name.
3

Add credits before processing

Creating a key does not add free processing credits. Purchase credits before starting a background-removal job.

Testing Authentication

Test your API key by checking your credit balance:
Success Response:

Authentication Errors

Invalid API Key (401)

Common causes:
  • Typo in the API key
  • Using wrong header name (should be X-Api-Key)
  • API key was deleted or deactivated

Missing API Key (401)

Solution: Make sure you include the X-Api-Key header in your request.

Security Best Practices

Never use API keys in client-side JavaScript, mobile apps, or any publicly accessible code.
Store your API key in environment variables, not in your source code:
Regularly rotate your API keys. Create a new key before deleting the old one to avoid downtime.
Use different API keys for development, staging, and production environments.

Rate Limits

Limits can vary by endpoint and account. Handle 429 Too Many Requests responses with backoff, and contact support before planning a high-volume workload instead of relying on a fixed undocumented quota.