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