AI Video Generation Callbacks
When you submit a video generation task to the Runway API, you can use the callBackUrlparameter to set a callback URL. The system will automatically push the results to your specified address when the task is completed.
Callback Mechanism Overview
Callback Timing
Callback Method
Callback Request Format
callBackUrl in the following format:Success Callback
Failure Callback
{
"code": 200,
"msg": "All generated successfully.",
"data": {
"task_id": "ee603959-debb-48d1-98c4-a6d1c717eba6",
"video_id": "485da89c-7fca-4340-8c04-101025b2ae71",
"video_url": "https://file.com/k/xxxxxxx.mp4",
"image_url": "https://file.com/m/xxxxxxxx.png"
}
}Status Code Description
Parameter Description
| Parameter | Type | Required | Description |
|---|---|---|---|
code | integer | Yes | Callback status code indicating task processing result |
msg | string | Yes | Status message providing detailed status description |
data.task_id | string | Yes | Task ID, consistent with the taskId returned when you submitted the task |
data.video_id | string | Yes | Generated video ID for identification and tracking |
data.video_url | string | No | Accessible video URL, valid for 14 days. Empty on failure |
data.image_url | string | No | Cover image URL of the generated video. Empty on failure |
Status Code Details
| Status Code | Description |
|---|---|
| 200 | Success - Video generation completed successfully |
| 400 | Client Error - Inappropriate content, format error, quota limit, or other client-side issues |
| 500 | Server Error - Internal server error during video generation |
Common Error Messages
Callback Reception Examples
Node.js
Python
PHP
Best Practices
Callback URL Configuration Recommendations
1.
2.
3.
4.
5.
6.
Important Reminders