Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xingchaoyiqing.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to check the status of a Vidu video generation task and retrieve the result once it completes. Video generation is asynchronous — you should poll this endpoint periodically after submitting a task via Create Video Task until the status reaches completed or failed.

Endpoint

GET /v1/result/{id}

Authentication

Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string
required
The unique task identifier returned by the Create Video Task endpoint in the id field.

Response Fields

id
string
The unique task identifier.
object
string
Object type. Always "Video".
created
integer
Unix timestamp of when the task was created.
model
string
The model used for this task (e.g. viduq3-pro or viduq3-turbo).
status
string
Current task status:
  • queued — task is waiting in the processing queue
  • processing — the model is actively generating the video
  • completed — generation finished; video_url is populated
  • failed — generation failed; see error for details
video_url
string
Direct download URL for the generated video (MP4 format). Only present when status is "completed". null while processing.
actualDuration
number
Actual output duration of the generated video in seconds. Only present when status is "completed".
totalTokens
number
Total token count consumed by this task. Populated after completion.
error
string
Error message describing the reason for failure. Only present when status is "failed".

Task Status Flow

The task moves through the following states: queuedprocessingcompleted or failed
StatusMeaning
queuedTask accepted and waiting to be picked up by the model
processingVidu model is actively generating the video
completedGeneration succeeded — retrieve the video via video_url
failedGeneration encountered an error — check the error field

Polling Advice

Recommended polling interval: 30–60 seconds.Estimated generation times by model:
  • viduq3-turbo — typically 2–4 minutes
  • viduq3-pro — typically 3–6 minutes
Stop polling as soon as status is completed or failed. Polling too frequently may trigger rate limiting.

Video URL Notes

Generated video URLs are valid for 24 hours only. Download and store the video file in your own storage system as soon as generation completes — the URL will become inaccessible after expiry.
  • Videos are delivered in MP4 format
  • The URL is a direct download link — no additional authentication required

Code Examples

curl --request GET \
  --url https://zcbservice.aizfw.cn/kyyReactApiServer/v1/result/video_fd35ee52-2a98-44a6-b930-29a88ce9b8fd \
  --header 'Authorization: Bearer YOUR_API_KEY'

Example Responses

While processing:
{
  "id": "video_fd35ee52-2a98-44a6-b930-29a88ce9b8fd",
  "object": "Video",
  "created": 1774836724,
  "model": "viduq3-pro",
  "status": "processing",
  "video_url": null,
  "totalTokens": null,
  "error": null
}
On completion:
{
  "id": "video_fd35ee52-2a98-44a6-b930-29a88ce9b8fd",
  "object": "Video",
  "created": 1774836724,
  "model": "viduq3-pro",
  "status": "completed",
  "video_url": "https://cdn.example.com/video_fd35ee52.mp4",
  "actualDuration": 5,
  "totalTokens": 1500,
  "error": null
}
On failure:
{
  "id": "video_fd35ee52-2a98-44a6-b930-29a88ce9b8fd",
  "object": "Video",
  "created": 1774836724,
  "model": "viduq3-pro",
  "status": "failed",
  "video_url": null,
  "totalTokens": null,
  "error": "Content policy violation: prompt contains restricted content."
}