Getting Started

Installation

Install and initialize SDKs for Node.js and Python projects.

Node.js SDK

Requires Node.js 18+.

Use ESM or TypeScript for best DX.

GitHub: https://github.com/JsonChao/removebgvideo-node

npm install removebgvideo-node

Python SDK

Requires Python 3.9+.

Recommended to install in a virtualenv.

GitHub: https://github.com/JsonChao/removebgvideo-python

pip install removebgvideo

Initialize Client

Runtime	Snippet
Node.js	new RemoveBGVideoClient(process.env.REMOVEBGVIDEO_API_KEY)
Python	RemoveBGVideoClient(api_key=os.environ['REMOVEBGVIDEO_API_KEY'])

import { RemoveBGVideoClient } from 'removebgvideo-node';

const client = new RemoveBGVideoClient(process.env.REMOVEBGVIDEO_API_KEY!);

# Python
from removebgvideo import RemoveBGVideoClient

client = RemoveBGVideoClient(api_key='YOUR_API_KEY')

Dependency Guidelines

Pin SDK version in production workloads.
Upgrade in staging first and replay representative jobs.
Log SDK version in job metadata for troubleshooting.

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.

Tip: Treat docs examples as baseline templates; finalize payload defaults in your own backend policy layer.

Acceptance Checklist

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

Environment Hardening

Load API keys from secret manager, not .env in shared hosts.
Pin Node/Python runtime version in CI and deployment.
Run SDK smoke test on startup to detect credential/config issues early.

Public API Workflow

Authentication