Docs

Integration docs for access routes and async video tasks

Start with authentication, task submission, polling, callbacks, billing records, and error states.

Auth Tasks Callbacks Billing
Route and documentation interface

Quick start

Quick start

Base URL and production API keys are provided after account review. Keep production keys separate from test keys.

Authorization: Bearer YOUR_API_KEY

Authentication

API keys are scoped by account and route access. Keep production keys separate from test keys.

Video task API

Submit a video job with prompt, input media when needed, resolution, duration, and callback URL.

POST /v1/video/tasks
{
  "model": "video-route-id",
  "prompt": "product video on a clean studio table",
  "resolution": "720p",
  "duration": 5,
  "callback_url": "https://example.com/callback"
}

Callbacks and polling

Callbacks include task ID, state, result metadata, and failure reason when applicable.

{
  "task_id": "vid_260128_8f42",
  "status": "completed",
  "result_url": "https://..."
}

Billing records

Billing records connect model, route, billing unit, amount, task ID, refund state, and timestamp.

Error codes

Error responses separate invalid input, access not enabled, provider unavailable, timeout, failed task, and refunded task.