API Reference

Process Video

Create and start background removal job.

Endpoint

POST /v1/jobs

Request Fields

Field	Type	Required	Description
video_url	string	yes	Input video URL (from upload or external URL)
output_format	string	no	Default webm; webm/mov/mp4/gif/webp/png_sequence
bg_type	string	no	Default transparent; transparent/green/white/black/blue/custom
model	string	no	Default original; original/light/pro/human
text_prompt	string	no	Used with pro model
webhook_url	string	no	Receive job.started/completed/failed callbacks
bg_color	number[]	no	RGB array for custom background
auto_start	boolean	no	Default true; create draft job when false

Example Request

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
  }'

Response

Field	Type	Description
success	boolean	Request accepted
id	string	Track this id for status polling
status	string	Initial status, usually processing
message	string	Submission result message

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

Process Request Pattern

Pattern	When to Use
Direct /api/process	Simple integrations and legacy compatibility
Draft + /v1/jobs/{job_id}/start	Enterprise workflows requiring pre-validation

When to Use Process Video

Process Video belongs to the API Reference section and covers create and start background removal job.

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 Process Video 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.

Page	Why It Matters
Upload Video	Continue with api reference context: /docs/api-reference/upload-video/
Start Job	Continue with api reference context: /docs/api-reference/start-job/
Introduction	Continue with api reference context: /docs/api-reference/introduction/
API Overview	Return to the developer API overview: /api/

FAQ

Question	Answer
Is Process Video required for every integration?	Use it when your integration calls this endpoint directly; otherwise review it to understand the contract behind SDK helpers.
What should I test before going live?	Verify success, failure, timeout, retry, and insufficient-credit paths with realistic video files and the same output format you plan to ship.
How does this connect to the rest of the API?	Most workflows connect upload or source URL handling, job creation, status polling, output retrieval, usage tracking, and operational logging.

Upload Video

Start Job