Public API v1 Admin

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

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

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.

When to Use Public API v1 Admin

Public API v1 Admin belongs to the API Reference section and covers reserved for internal operations and currently not exposed as public customer api.

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 Admin 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