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.

After you create a Sora video generation task, use this endpoint to check its status and retrieve the download URL once generation is complete. Pass the id returned by the Create Video Task endpoint as the path parameter, and keep polling until status is "completed" or "failed".
Video generation is asynchronous and typically takes several minutes. Do not expect an immediate result — continue polling at the recommended interval until the task reaches a terminal status.

​
Endpoint

Base URL:  https://zcbservice.aizfw.cn/kyyReactApiServer
Endpoint:  GET /v1/result/{id}
Full URL:  https://zcbservice.aizfw.cn/kyyReactApiServer/v1/result/{id}
All requests must include your API key as a Bearer token: 
Authorization: Bearer YOUR_API_KEY

​
Path Parameters

​
id
string
required
The unique task identifier returned by the Create Video Task endpoint (e.g. sora_abc123def456).

​
Response Fields

​
id
string
Unique identifier of the video generation task.
​
object
string
Object type. Always "video.generation".
​
created
integer
Unix timestamp (seconds) of when the task was created.
​
model
string
The model used for generation (e.g. "openAiSora2Plus").
​
status
string
Current task status:
  • queued — task is in the queue, waiting to be processed
  • processing — the Sora model is actively generating the video
  • completed — generation succeeded; video_url is populated
  • failed — generation failed; see error for details
​
video_url
string
A direct download URL for the generated video (MP4 format). Only present when status is "completed". The URL is valid for 1 day — download and store the video before it expires.
​
actualDuration
number
The actual output duration of the video in seconds. Only present when status is "completed".
​
error
string
Error message describing why the task failed. Only present when status is "failed".

​
Status Flow

StepStatusMeaning
1queuedTask created and added to the processing queue
2processingSora model is generating the video
3completedVideo is ready; retrieve it via video_url
—failedAn error occurred; inspect the error field

​
Polling Recommendations

Poll every 30–60 seconds. Video generation takes significantly longer than image generation — polling too frequently wastes quota and may trigger rate limits.
  • Stop polling as soon as status is "completed" or "failed".
  • Use exponential back-off if you encounter 429 Too Many Requests responses.

​
Generation Time Estimates

Video LengthEstimated Time
4 s~1–3 minutes
8 s (typical)~2–5 minutes
12 s~3–8 minutes

​
Video URL Notes

The video_url is only valid for 1 day after the task completes. Download and save the file to your own storage system promptly — after expiry you will not be able to retrieve the video.
  • Format: MP4
  • The URL is a pre-signed temporary link; do not share it publicly as a permanent link.

​
Code Examples

curl --request GET \
  --url https://zcbservice.aizfw.cn/kyyReactApiServer/v1/result/sora_abc123def456 \
  --header 'Authorization: Bearer YOUR_API_KEY'
Example response — processing: 
{
  "id": "sora_abc123def456",
  "object": "video.generation",
  "created": 1761635478,
  "model": "openAiSora2Plus",
  "status": "processing",
  "video_url": null,
  "error": null
}
Example response — completed: 
{
  "id": "sora_abc123def456",
  "object": "video.generation",
  "created": 1761635478,
  "model": "openAiSora2Plus",
  "status": "completed",
  "video_url": "https://cdn.example.com/videos/sora_abc123def456.mp4",
  "actualDuration": 8,
  "error": null
}