API Playground

Overview

Use this page as a test harness before integrating SDK or backend workers.

For visual JSON testing, use Composition Builder: https://removebgvideo.com/composition-builder/

Recommended Test Flow

Reusable cURL Template

# 1) Create job
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.removebgvideo.com/uploads/your-video.mp4",
    "model": "original",
    "output_format": "webm",
    "background": { "type": "transparent" },
    "auto_start": false
  }'

# 2) Start job (replace JOB_ID)
curl -X POST https://api.removebgvideo.com/v1/jobs/JOB_ID/start \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "pro",
    "text_prompt": "person, clothing accessories, glowing ring",
    "background": { "type": "transparent" }
  }'

# 3) Poll status
curl -X GET https://api.removebgvideo.com/v1/jobs/JOB_ID \
  -H "X-Api-Key: YOUR_API_KEY"

Pre-Production Checklist

1. Run at least 3 representative videos for each selected model.
2. Validate both success and failure branches in your integration.
3. Record average processing time and credit usage for your SLA baseline.
4. Confirm API key usage appears in API Management usage view.

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

Recommended Test Scenarios