API Reference
Public API v1 Admin
Reserved for internal operations and currently not exposed as public customer API.
Availability
Public customers should not depend on /v1/admin routes at this stage.
Use Dashboard → API Management for key creation, usage views, and operational controls.
Available Alternatives
| Capability | Recommended Path |
|---|---|
| Create and manage API keys | https://removebgvideo.com/dashboard (API Management tab) |
| Job orchestration | Public /v1/jobs endpoints |
| Usage insights | Public /v1/usage/summary and /v1/usage/events |
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 |
Admin API Safety Rules
- Keep API key management in Dashboard API Management.
- Audit key creation/deletion and last-used timestamps regularly.
- Use environment-scoped keys and rotate in controlled windows.