Authentication

Current State

Public API routes under /v1 require X-Api-Key and enforce per-key rate limit.

Legacy routes under /api/* are kept for backward compatibility and do not require X-Api-Key.

Required Headers

Server-side Only

• Never expose X-Api-Key in browser code.
• Call /v1 endpoints from backend routes or workers.
• Use separate API keys per environment and integration.

Common Auth Errors

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.

Key Rotation Policy

1. Create new key and deploy it in parallel.
2. Shift traffic gradually to the new key.
3. Monitor usage and errors for 24h.
4. Disable old key only after stable verification.

When to Use Authentication

Authentication belongs to the Getting Started section and covers authentication model for legacy and public api endpoints.

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

• Use Authentication when you are setting up a new RemoveBGVideo integration or onboarding another engineer.
• Convert each checklist item into a small staging test before enabling production traffic.
• Keep these defaults in your own backend configuration so UI clients do not need to understand every API detail.

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 ship with a personal sandbox API key in production.
• Do not skip failure-path testing; invalid files, insufficient credits, and transient worker errors need visible handling.
• Do not hardcode model and output defaults in multiple services without one owner for changes.

Related Documentation

FAQ