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 poll the status of a Grok video generation task and retrieve the output URL once generation completes. Because video generation is asynchronous, you should call this endpoint periodically after submitting a task via Create Video Task. Stop polling when 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. This is the id field in the creation response.

​
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., grok_video3, grok_video3_pro, grok_video3_max, or grok_video3_stable).
​
status
string
Current task status:
  • queued — task is waiting in the processing queue
  • processing — the Grok model is actively generating the video
  • completed — generation finished; video_url is populated
  • failed — generation failed; see error for details
​
video_url
string
Temporary download URL for the generated video. Only present when status is "completed". null while the task is pending or processing.
​
actualDuration
number
Actual output duration of the generated video in seconds. Only present when status is "completed".
​
error
string
Error message describing the failure reason. Only present when status is "failed".

​
Task Status Flow

queued → processing → completed or failed
StatusMeaning
queuedTask accepted, waiting to be processed
processingGrok model is actively generating the video
completedVideo ready — retrieve via video_url
failedAn error occurred — check error for details

​
Polling Advice

Recommended polling interval: 30–60 seconds.Generation time depends on the model, requested duration, and number of reference images:
  • Longer durations (e.g., 20–30s with grok_video3_max) will take more time
  • More reference images generally increases processing time
  • grok_video3_pro (fixed 10s, per-call billing) is typically faster than variable-duration models at long durations
Stop polling as soon as status is completed or failed. Polling too frequently may trigger rate limiting.

​
Result URL Notes

The video_url is a temporary download link. Download and persist the video to your own storage as soon as generation completes — the link will expire and become inaccessible.
  • If the prompt or reference images violate content policies, the task will return failed status
  • Tasks with many reference images or long durations may take noticeably longer to process

​
Code Examples

curl --request GET \
  --url https://zcbservice.aizfw.cn/kyyReactApiServer/v1/result/video_grok_1234567890 \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Example Responses

While processing: 
{
  "id": "video_grok_1234567890",
  "object": "video",
  "created": 1774836724,
  "model": "grok_video3_max",
  "status": "processing",
  "video_url": null,
  "error": null
}
On completion: 
{
  "id": "video_grok_1234567890",
  "object": "video",
  "created": 1774836724,
  "model": "grok_video3_max",
  "status": "completed",
  "video_url": "https://cdn.example.com/video_grok_1234567890.mp4",
  "actualDuration": 10,
  "error": null
}
On failure: 
{
  "id": "video_grok_1234567890",
  "object": "video",
  "created": 1774836724,
  "model": "grok_video3_max",
  "status": "failed",
  "video_url": null,
  "error": "Reference image could not be accessed."
}