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

When to Use API Playground

API Playground belongs to the API Reference section and covers how to test endpoints quickly with real api keys and production-like payloads.

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

• Validate the exact API Playground contract before wiring it into backend workers or customer-facing flows.
• Use the field tables and examples to create request/response tests in staging.
• Capture job_id, request_id, model, output_format, and user context whenever this endpoint participates in a production workflow.

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 assume a processing request returns a finished video immediately; completed output is asynchronous.
• Do not discard failed-job payloads before logging the error code and request context.
• Do not let polling loops run without timeout, backoff, or terminal-state handling.

Related Documentation

FAQ