Skip to main content

​
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

​
API Path Version

The current public endpoints use /v1/ in the request path. Integrations should use the documented path for each endpoint rather than relying on an undocumented response-version header.

​
Authentication

All API requests require an API key in the X-Api-Key header:

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: Usage depends on duration, model, frame rate, and optional turbo processing (see Models)

​
Error Handling

The API uses standard HTTP status codes: