AI Video Generation Callbacks
When you submit a task to Generate AI Video with the callBackUrlparameter, the system pushes the result to that URL when the task finishes.
Callback Mechanism Overview
Callback Request Format
data.resultJson, a JSON string: JSON.parse(data.resultJson).resultUrls[0].Success Callback
Failure Callback
{
"code": 200,
"msg": "Playground task completed successfully.",
"data": {
"taskId": "94bbfeaa1383c296cd61ba5dfcbfe30e",
"model": "runway",
"state": "success",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A cartoon fox paints a rainbow on a wooden fence, colorful 3D animation\\\",\\\"duration\\\":5,\\\"quality\\\":\\\"720p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"runway\"}",
"resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/p/c03630ba7484476a905fc14625b7304a_1_1791218754_8541.mp4\"]}",
"costTime": 68,
"creditsConsumed": 12,
"createTime": 1791218688000,
"completeTime": 1791218756020,
"updateTime": 1791218756020
}
}Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | integer | 200 = success, 501 = failed |
msg | string | Status message |
data.taskId | string | Task ID returned when you submitted the task |
data.model | string | Model used for the task (runway) |
data.state | string | success or fail |
data.param | string | Parameters submitted when creating the task, as a JSON string |
data.resultJson | string | Result as a JSON string, e.g. {"resultUrls":["https://...mp4"]}. Present on success |
data.failCode | string | Failure code. Present on failure |
data.failMsg | string | Failure reason. Present on failure |
data.costTime | integer | Task duration in seconds |
data.creditsConsumed | number | Credits consumed by the task |
data.createTime / data.completeTime / data.updateTime | integer | Unix timestamps in milliseconds |
Callback Reception Examples
Node.js
Python
PHP
Best Practices
Callback URL Configuration Recommendations
1.
2.
3.
taskId may be delivered more than once.4.
5.
Important Reminders