API Reference
Health
Infrastructure health check (API, RunPod config, R2 config).
Endpoint
GET /health
Example Request
curl -X GET https://api.removebgvideo.com/healthResponse
| Field | Description |
|---|---|
| status | healthy or degraded |
| checks.api | API process status |
| checks.runpod_configured | RunPod API and endpoint configuration state |
| checks.r2_configured | Object storage configuration state |
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 |
Health Monitoring
| Signal | Alert Threshold |
|---|---|
| Health endpoint downtime | > 2 consecutive failures |
| Job failure rate | > baseline + agreed error budget |
| Processing latency p95 | > SLO for 15+ minutes |
When to Use Health
Health belongs to the API Reference section and covers infrastructure health check (api, runpod config, r2 config).
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 Health 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.
FAQ
| Question | Answer |
|---|---|
| Is Health 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. |