Public API v1 Usage

Endpoints

Summary Example

curl -X GET "https://api.removebgvideo.com/v1/usage/summary?days=7" \
  -H "X-Api-Key: YOUR_API_KEY"

Events Example

curl -X GET "https://api.removebgvideo.com/v1/usage/events?limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"

Notes

• summary supports days=1..90
• events supports limit=1..100
• both endpoints require X-Api-Key

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

Usage Analytics Recommendations

1. Aggregate usage by model and customer segment daily.
2. Detect abnormal spikes in failed jobs or spend.
3. Feed usage summary into quota/budget enforcement automation.

When to Use Public API v1 Usage

Public API v1 Usage belongs to the API Reference section and covers usage analytics endpoints for api consumers.

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 Public API v1 Usage 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