API Key Format

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

Request Header

Include your API key in the X-Api-Key header for all requests:
curl -X GET https://api.videobgremover.com/v1/credits \
  -H "X-Api-Key: vbr_your_api_key_here"
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

Purchase credits

You need credits to create an API key. Buy credits in your dashboard.
3

Generate API key

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

Testing Authentication

Test your API key by checking your credit balance:
curl -X GET https://api.videobgremover.com/v1/credits \
  -H "X-Api-Key: vbr_your_api_key_here"
Success Response:
{
  "user_id": "user-uuid",
  "total_credits": 100,
  "remaining_credits": 95,
  "used_credits": 5
}

Authentication Errors

Invalid API Key (401)

{
  "error": "Invalid API key"
}
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)

{
  "error": "API key required"
}
Solution: Make sure you include the X-Api-Key header in your request.

Security Best Practices

Rate Limits

Each API key has the following limits:
  • 100 requests per minute
  • 3 video processing jobs per minute
Rate limit headers are included in all responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response.