Quick Start

Overview

A full job lifecycle has 3 core calls: upload (optional), process, and status check.

For production, keep job metadata in your database and poll status in a worker or scheduled task.

1) Upload Video (Optional)

If your video is local, upload it first to get a hosted video_url.

curl -X POST https://api.removebgvideo.com/v1/uploads \
  -H "X-Api-Key: YOUR_API_KEY" \
  -F "file=@./input.mp4"

2) Process Video

Submit /v1 processing request with model and output settings.

curl -X POST https://api.removebgvideo.com/v1/jobs \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://cdn.example.com/input.mp4",
    "model": "original",
    "background": { "type": "transparent" },
    "output_format": "webm",
    "auto_start": true
  }'

3) Check Job Status

Poll every 2-5 seconds. Stop polling when status is completed or failed.

• completed: output is ready and downloadable
• failed: read error.message and retry if transient
• processing: continue polling with backoff

curl -X GET https://api.removebgvideo.com/v1/jobs/{job_id} \
  -H "X-Api-Key: YOUR_API_KEY"

Production Checklist

1. Persist job_id and user_id mapping in your DB.
2. Implement retries for 429 and 5xx errors.
3. Use /v1/usage/summary and /v1/usage/events for API usage metrics.
4. Use /health for availability checks in monitors.

Production Readiness

• Pin SDK/API versions in deployment manifests and release notes.
• Record request_id/job_id in logs for every API interaction.
• Run smoke tests after each deploy using a known short test video.
• Separate dev/staging/prod keys and rotate keys regularly.

Acceptance Checklist

1. Validate one success path and one failure path end-to-end.
2. Confirm credits, usage metrics, and output links are consistent.
3. Set retry and timeout policy for 429/5xx response handling.
4. Document rollback procedure for integration incidents.

Quick Start Decision Points

When to Use Quick Start

Quick Start belongs to the Getting Started section and covers run your first production-ready background removal job in minutes.

The page is written for developers and operators who need predictable video background removal behavior in production, not just a one-off demo request.

• Use Quick Start when you are setting up a new RemoveBGVideo integration or onboarding another engineer.
• Convert each checklist item into a small staging test before enabling production traffic.
• Keep these defaults in your own backend configuration so UI clients do not need to understand every API detail.

Implementation Notes

Before you promote this workflow, test it with at least one short clip, one longer clip, and one visually difficult clip from your actual product or customer segment.

For support and debugging, persist the original input reference, selected model, output format, credit usage, and final job status alongside your internal user or project id.

• Do not ship with a personal sandbox API key in production.
• Do not skip failure-path testing; invalid files, insufficient credits, and transient worker errors need visible handling.
• Do not hardcode model and output defaults in multiple services without one owner for changes.

Related Documentation

FAQ