API Reference
Introduction
Current backend endpoints and request conventions.
Base URL
Base URL: https://api.removebgvideo.com
Public customer integrations should use /v1/jobs and /v1/usage endpoints.
Legacy /api/* routes remain available for backward compatibility.
Standard Headers
| Header | Required | Description |
|---|---|---|
| X-Api-Key | Yes (/v1/*) | Public API authentication header |
| Content-Type: application/json | Yes (POST /v1/jobs, /v1/jobs/{job_id}/start) | JSON request body |
| multipart/form-data | Yes (POST /v1/uploads) | File upload form |
Available Endpoints
| Endpoint | Method | Purpose |
|---|---|---|
| /v1/uploads | POST | Upload local video and get video_url |
| /v1/jobs | POST | Create job (supports auto_start) |
| /v1/jobs/{job_id}/start | POST | Start pending draft job |
| /v1/jobs/{job_id} | GET | Get processing status |
| /v1/jobs | GET | List jobs |
| /v1/usage/summary | GET | Get usage summary |
| /v1/usage/events | GET | Get recent usage events |
| /api/download/{job_id} | GET | Get output URL when completed |
| /api/pricing | GET | Get model pricing config |
| /health | GET | Service health check |
Response Shape
Most processing responses include job_id, status, progress, output_url, and error fields.
API Contract Notes
- All clients should handle non-2xx responses as structured error payloads.
- Use explicit JSON schema validation for request payloads on your side.
- Treat output_url as an asynchronous artifact and not an immediate response contract.
- Persist job lifecycle state transitions for auditing and support.
Integration Verification
| Check | How to Verify |
|---|---|
| Authentication | Call endpoint with valid and invalid key, confirm 200 vs 401 |
| Rate limits | Burst test and confirm 429 handling with backoff |
| Idempotency | Retry same request and verify no duplicate side effects |
| Observability | Confirm request_id/job_id appears in logs and dashboards |
Versioning & Compatibility
- Pin to /v1 endpoints for stable integration contracts.
- Keep internal compatibility layer for legacy /api routes.
- Review changelog impact before enabling new request fields.