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 |