API Reference
Upload Video
Upload local video file and receive CDN video URL.
Endpoint
POST /v1/uploads
Request
Multipart form with single file field named file.
curl -X POST https://api.removebgvideo.com/v1/uploads \
-H "X-Api-Key: YOUR_API_KEY" \
-F "file=@./input.mp4"Constraints
| Rule | Value |
|---|---|
| Supported MIME | video/mp4, video/quicktime, video/webm, video/x-msvideo |
| Max file size | 500MB |
Legacy Compatibility
`POST /api/upload` remains available for backward compatibility, but new integrations should use `/v1/uploads`.
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Upload success flag |
| video_id | string | Unique uploaded video id |
| video_url | string | CDN URL for processing |
| filename | string | Original filename |
| size | number | Uploaded size in bytes |
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 |
Upload Validation Checklist
- Validate MIME type and extension before upload.
- Enforce max size and duration constraints in client and backend.
- Store returned video_url with upload metadata for traceability.