Introduction
Generate images and videos through one API with native model parameters, transparent per-task billing, and webhooks.
What Kerox does
Kerox gives you a single HTTP API for image and video generation models from makers such as ByteDance and Alibaba. Every model uses the same task lifecycle (POST /v1/tasks, poll or receive a webhook, download outputs), while keeping each model's native input parameters intact.
- Base URL:
https://api.kerox.ai/v1 - Authentication:
Authorization: Bearer <your-api-key> - Format: JSON requests and responses (except multipart uploads to
/v1/files) - Currency: USD strings with 4 decimal places (
"0.0300"), billed directly from your wallet
Core endpoints
| Endpoint | Purpose |
|---|---|
POST /v1/tasks | Create a generation task (optionally wait up to 60 s synchronously) |
GET /v1/tasks/{id} | Poll a task's status, outputs, cost, and error details |
GET /v1/tasks | List recent tasks with cursor pagination and filters |
POST /v1/tasks/{id}/cancel | Cancel a queued task and release its hold |
GET /v1/models | List models with live input_schema and your account's pricing |
POST /v1/estimate | Estimate cost for a request without creating a task or holding funds |
POST /v1/files | Upload reference images, videos, or audio (7-day retention) |
GET /v1/account | Read balance, held amount, limits, and the number of tasks in progress |
GET /v1/usage | Usage and spend by day and model |
Native and unified formats
By default, input follows the model maker's native parameter names (format: "native"), documented in each model's input_schema. When you want to switch between models without rewriting common fields (prompt, images, aspect_ratio, resolution, duration), pass format: "unified" on supported models.
Next steps
Create a key and generate your first image in about two minutes.
How wallet holds, settlements, refunds, and token-billed video rates work.
Interactive OpenAPI 3.1 reference with Try it support.
Browse schemas, parameters, and live prices generated from config.