Documentation Index
Fetch the complete documentation index at: https://apixo.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
What this model is for
Use this page after trying Vidu Q3 in the APIXO playground. It shows the model ID, request body, result format, and the shared async workflow links you need for API integration.Model ID, endpoint, and auth
- Model ID:
vidu-q3 - Base URL:
https://api.apixo.ai/api/v1
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/generateTask/vidu-q3 | Create a generation task |
| GET | /api/v1/statusTask/vidu-q3 | Query task status |
Authentication
All requests must include your API key in the request headers:Request Body
Parameters
Execution mode:
async (polling) or callbackCallback URL. Required when
request_type=callback. (conditional)Routing strategy:
auto, value, official, or a specific provider channelModel input parameters
text-to-video- Generate a video from text onlyimage-to-video- Generate a video from 1 or 2 imagesturbo-text-to-video- Turbo text-to-video modeturbo-image-to-video- Turbo image-to-video mode with 1 or 2 images
Copy-paste quickstart
Text-to-video (text-to-video)
image-to-video, 1 image)
image-to-video, 2 images)
Response and result format
POST /api/v1/generateTask/vidu-q3
On success, the API returns ataskId that you can use to query task status later.
Success:
GET /api/v1/statusTask/vidu-q3
UsetaskId to query the execution status and final result.
Polling result fields
Unique task identifier.
Current task state:
pending, processing, success, or failed.JSON string containing
resultUrls array. Only present on success. Parse with JSON.parse().Error code. Only present when
state is failed. See Error Codes.Human-readable error message. Only present when
state is failed.Task creation timestamp (Unix milliseconds).
Task completion timestamp (Unix milliseconds).
Processing duration in milliseconds.
Polling and webhook result retrieval
Userequest_type: "async" with the status endpoint when your app wants to poll for completion. Use request_type: "callback" with callback_url when your production service should receive the final result automatically. See Webhooks for delivery details.
Common errors
| Code | Description |
|---|---|
| 400 | Invalid parameters or malformed request |
| 401 | Missing or invalid API key |
| 402 | Insufficient balance |
| 429 | Rate limit exceeded |
| Fail Code | Description |
|---|---|
CONTENT_VIOLATION | The request violates safety guidelines |
INVALID_IMAGE_URL | The provided image URL could not be fetched |
Rate Limits
| Limit | Value |
|---|---|
| Request rate | 60 requests per minute |
| Concurrent tasks | 10 |
429 error. Retry later.
Tips
- Image count by mode: For
image-to-videoandturbo-image-to-video, the number ofimage_urlsdetermines the workflow.1image creates a single-image animation.2images create a first-and-last-frame transition, where the first image is the start frame and the second image is the end frame. - Billing: Charges are calculated per second, and billed seconds are equal to
duration. For pricing by resolution, see Pricing. - Polling recommendation: After submitting a task, wait about 60-90 seconds before polling, then poll every 5 seconds. For higher concurrency, prefer
callbackmode. - Result URL lifetime: Output URLs may expire. Download and store results as soon as possible.