​
API Reference

The VideoBGRemover API provides programmatic access to our video background removal service. This section contains the complete API reference with interactive examples.

​
Base URL

https://api.videobgremover.com/v1

​
Versioning

The VideoBGRemover API uses semantic versioning. The current version is v1.2.0.
  • URL versioning: All endpoints use /v1/ in the path
  • Header versioning: All responses include X-API-Version: 1.2.0 header
Version headers are automatically included in all API responses to help you track which version you’re using.

​
Authentication

All API requests require an API key in the X-Api-Key header: 
curl -H "X-Api-Key: vbr_your_api_key_here" \
  https://api.videobgremover.com/v1/credits

Get Your API Key

Generate your API key in the dashboard

​
Interactive Playground

Each endpoint below includes an interactive playground where you can test API calls directly from this documentation. The playground uses your API key to make real requests to our servers.

​
Response Examples

For detailed examples of API responses in different states, see the API Responses page.

​
Rate Limits & File Limits

  • File Size: Maximum 1GB per video
  • Supported Formats: MP4, MOV, WebM, AVI, MKV, M4V
  • Credits: 1 credit per second of video duration

​
Error Handling

The API uses standard HTTP status codes:
CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
402Payment Required - Insufficient credits
413Payload Too Large - File exceeds 1GB
500Internal Server Error