Skip to main content

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.

Overview

Vidu Q3 is a per-second video generation model for Standard and Turbo text-to-video and image-to-video workflows. Use this page when you are ready to call the API after trying the model in the APIXO playground.
CapabilityValue
Model IDvidu-q3
Modestext-to-video, image-to-video, turbo-text-to-video, turbo-image-to-video
Prompt length1-5000 characters
DurationAny integer from 1 through 16 seconds
Resolutions540p, 720p, 1080p
Text-mode aspect ratios16:9, 9:16, 4:3, 3:4, 1:1
Text-mode stylesgeneral, anime
Reference images1-2 URLs for image modes
OutputMP4 video URL array in resultJson.resultUrls

Endpoint and authentication

Base URL:
https://api.apixo.ai/api/v1
MethodEndpointPurpose
POST/generateTask/vidu-q3Submit a generation task
GET/statusTask/vidu-q3?taskId={taskId}Poll task status and retrieve results
All requests require your APIXO API key:
Authorization: Bearer YOUR_API_KEY
Submit requests also require:
Content-Type: application/json

Copy-paste async quickstart

This minimal request submits a Standard text-to-video task and returns a taskId.
curl -X POST "https://api.apixo.ai/api/v1/generateTask/vidu-q3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "text-to-video",
      "prompt": "a cinematic flyover of a futuristic city at sunrise",
      "resolution": "720p",
      "duration": 8,
      "style": "general",
      "aspect_ratio": "16:9",
      "sound": true,
      "bgm": true
    }
  }'
Successful response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}
Save the taskId; you need it to poll for the final video.

Poll for result

curl -X GET "https://api.apixo.ai/api/v1/statusTask/vidu-q3?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"
Processing response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "processing",
    "createTime": 1767965610929
  }
}
Success response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://r2.apixo.ai/video.mp4\"]}",
    "createTime": 1767965610929,
    "completeTime": 1767965730929,
    "costTime": 120000
  }
}
Failed response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "PromptInvalid",
    "failMsg": "Prompt is invalid or rejected by upstream service",
    "createTime": 1767965610929,
    "completeTime": 1767965620132
  }
}
Parse resultJson after state becomes success:
const payload = JSON.parse(data.resultJson);
const videoUrls = payload.resultUrls;

Request body

Text-to-video

{
  "request_type": "async",
  "input": {
    "mode": "text-to-video",
    "prompt": "a polished app launch teaser with a glowing phone rotating above a reflective surface",
    "resolution": "720p",
    "duration": 8,
    "style": "general",
    "aspect_ratio": "16:9",
    "movement": "auto",
    "sound": true,
    "bgm": true,
    "seed": 1234
  }
}

Single-image animation

{
  "request_type": "async",
  "input": {
    "mode": "image-to-video",
    "prompt": "make this product photo come alive with subtle camera motion",
    "resolution": "1080p",
    "duration": 4,
    "image_urls": [
      "https://example.com/start.jpg"
    ],
    "sound": true,
    "bgm": true
  }
}

First-and-last-frame transition

{
  "request_type": "async",
  "input": {
    "mode": "image-to-video",
    "prompt": "transition smoothly from the first frame to the last frame",
    "resolution": "720p",
    "duration": 8,
    "image_urls": [
      "https://example.com/start.jpg",
      "https://example.com/end.jpg"
    ],
    "sound": true,
    "bgm": true
  }
}

Turbo text-to-video

{
  "request_type": "async",
  "input": {
    "mode": "turbo-text-to-video",
    "prompt": "a fast concept preview of a sleek electric scooter driving through a city street",
    "resolution": "540p",
    "duration": 4,
    "aspect_ratio": "9:16",
    "sound": true,
    "bgm": true
  }
}

Parameters

request_type
string
default:"async"
Result delivery mode. Omit this field or use async for polling with statusTask, or use callback for webhook delivery.
callback_url
string
Required when request_type is callback. Must be a public URL that can receive the final task payload. See Webhooks.
input
object
required
Vidu Q3 input parameters.
ModeRequired mediaText controlsBilling tier
text-to-videoNonestyle, aspect_ratioStandard
image-to-videoimage_urls with 1-2 imagesNot usedStandard
turbo-text-to-videoNonestyle, aspect_ratioTurbo
turbo-image-to-videoimage_urls with 1-2 imagesNot usedTurbo
Use public, directly accessible image URLs for image modes. The task is rejected if an image URL cannot be accessed or processed.

Response format

Submit task response

POST /generateTask/vidu-q3 returns a task ID when the task is accepted:
code
integer
API status code. 200 means the task was accepted.
message
string
Human-readable status message.
data.taskId
string
Unique task identifier used with the status endpoint.

Status response fields

taskId
string
Unique task identifier.
state
string
Current task state: pending, processing, success, or failed.
resultJson
string
JSON string containing generated video URLs in resultUrls. Present when state is success.
failCode
string
Machine-readable failure code. Present when state is failed.
failMsg
string
Human-readable failure message. Present when state is failed.
createTime
integer
Task creation timestamp in Unix milliseconds.
completeTime
integer
Task completion timestamp in Unix milliseconds. Present after completion.
costTime
integer
Processing duration in milliseconds. Present after completion when timing data is available.

Webhook callback mode

Use callback mode when your backend should receive the final result automatically instead of polling.
curl -X POST "https://api.apixo.ai/api/v1/generateTask/vidu-q3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "callback",
    "callback_url": "https://your-server.com/webhooks/apixo",
    "input": {
      "mode": "turbo-image-to-video",
      "prompt": "animate the reference image with a smooth handheld camera move",
      "resolution": "720p",
      "duration": 4,
      "image_urls": [
        "https://example.com/reference-image.jpg"
      ],
      "sound": true,
      "bgm": true
    }
  }'
The callback payload uses the same top-level shape as status polling with code, message, and data. Successful callbacks include the final state and resultJson. See Webhooks for delivery requirements and retry behavior.

Billing

Vidu Q3 is billed per second. The selected mode determines whether the task uses the Standard or Turbo rate, and resolution determines the per-second unit price.
total cost = unit price x duration
Mode groupResolutionAPIXO price
Standard: text-to-video, image-to-video540p$0.063 / second
Standard: text-to-video, image-to-video720p$0.135 / second
Standard: text-to-video, image-to-video1080p$0.144 / second
Turbo: turbo-text-to-video, turbo-image-to-video540p$0.036 / second
Turbo: turbo-text-to-video, turbo-image-to-video720p$0.054 / second
Turbo: turbo-text-to-video, turbo-image-to-video1080p$0.072 / second
For current route and market comparison pricing, see Pricing.

Latency and polling

Video generation is long-running. Typical Vidu Q3 processing time is about 60-120 seconds, but actual latency may vary by mode, duration, resolution, prompt complexity, reference image accessibility, route queue load, and storage transfer time.
WorkloadTypical generation timeRecommended first pollPoll interval
Short Turbo previews60s-120s60s after task creation5s-10s
Standard text-to-video or image-to-video60s-180s60s-90s after task creation5s-10s
Longer or 1080p jobs2-4 minutes or longer90s after task creation10s
For production workloads, use callback mode to avoid frequent polling while video tasks run.
Result URLs are temporary. Download and store important outputs promptly after task completion. Rate limits and concurrency can vary by account, API key, and route. If you receive 429, slow down requests and retry with backoff. For account-level details, see System APIs.

Errors and troubleshooting

HTTP errors

CodeMeaningWhat to do
400Invalid request body, missing input, unsupported mode, empty or too-long prompt, invalid resolution, invalid duration, invalid style, invalid aspect_ratio, invalid movement, or invalid image_urlsFix the request before retrying
401Missing or invalid API keyCheck the Authorization header
402Insufficient balance or quotaAdd balance or switch account/key
403Key or route cannot access the model, or content was rejectedCheck permissions and revise the prompt or input
404Task not found when pollingCheck the taskId
429Rate limit or concurrency limit reachedRetry with exponential backoff
500Server error or unknown task failureRetry with backoff
502Upstream service errorRetry with backoff
504Upstream timeoutRetry or use callback mode for long-running jobs

Validation notes

ConditionBackend behavior
Missing inputRequest fails before task creation.
Missing modeRequest fails before task creation.
Unsupported modeRequest fails before task creation. Supported values are text-to-video, image-to-video, turbo-text-to-video, and turbo-image-to-video.
Missing, non-string, or empty promptRequest fails before task creation.
prompt longer than 5000 charactersRequest fails before task creation.
Missing or unsupported resolutionRequest fails before task creation. Supported values are 540p, 720p, and 1080p.
Missing durationRequest fails before task creation.
duration outside 1 through 16Request fails before task creation.
Unsupported style in text modesRequest fails before task creation. Supported values are general and anime.
Unsupported aspect_ratio in text modesRequest fails before task creation. Supported values are 16:9, 9:16, 4:3, 3:4, and 1:1.
Unsupported movementRequest fails before task creation. Supported values are auto, small, medium, and large.
Image mode without image_urlsRequest fails before task creation.
Image mode with zero or more than two imagesRequest fails before task creation.
image_urls contains non-string itemsRequest fails before task creation.
seed outside -1 through 2147483647Request fails before task creation.

Task failure codes

failCode is generated from APIXO’s mapped upstream error. Common values include:
Fail codeMeaningWhat to do
PromptInvalidPrompt was invalid or rejected by the upstream serviceRewrite the prompt and retry
SensitiveContentPrompt or input/output content was rejected by safety checksChange the prompt or reference image
ImageFormatIncorrectReference image format could not be processedUse a public, direct image URL in a common image format
RateLimitedUpstream rate limit was reachedRetry with exponential backoff
TimeoutUpstream timeoutRetry later or use callback mode
StreamErrorUpstream returned a 500-class generation errorRetry with backoff
Unknown errorUpstream returned an unmapped failureRetry with backoff or contact support with the taskId
See Error Codes for the full error reference.