Grok Imagine 文生视频
本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致;品牌与 API 域名已替换为 ModelFold。
接口
POST /jobs/createTask
完整 URL: https://ai.modelfold.online/v1/jobs/createTask
鉴权:所有请求都需要
Authorization: Bearer <API_KEY>请求头。
输出为 MP4 视频,带与画面同步生成的音轨(prompt 中的台词会被念出)。音频无法关闭。
查询任务状态
提交任务后,使用统一的查询端点检查进度并获取结果:
- 获取任务详情 — 了解如何查询任务状态并获取生成结果
TIP
对于生产环境,我们建议使用 callBackUrl 参数接收自动通知,而不是轮询状态端点。
相关资源
请求参数
请求体 (application/json)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 用于生成的模型名称。必填字段。 - 此端点必须使用 grok-imagine/text-to-video |
callBackUrl | string | 否 | 接收视频生成任务完成更新的 URL。可选但建议在生产环境中使用。 - 当视频生成完成时,系统将向此 URL POST 任务状态和结果 - 回调包含生成的视频 URL 和任务信息 - 您的回调端点应接受包含视频结果的 JSON 负载的 POST 请求 - 或者,使用获取任务详情端点轮询任务状态 |
input | object | 是 | 视频生成任务的输入参数 |
input.prompt | string | 是 | 描述期望视频运动的文本提示。必填字段。 - 应该对期望的视觉运动详细具体 - 描述运动、动作序列、摄影工作和时间安排 - 包含主体、环境和运动动态的细节 - 最大长度:5000 字符 - 支持英文提示 |
input.aspect_ratio | string | 否 | 指定生成视频的宽高比。控制输出的宽高比。 - 2:3: 竖向(垂直) - 3:2: 横向(水平) - 1:1: 正方形 - 16:9: 宽屏 - 9:16: 竖屏 默认值:2:3 可选值: 2:3 / 3:2 / 1:1 / 16:9 / 9:16。 示例:2:3。 |
input.mode | string | 否 | 指定影响运动风格和强度的生成模式。 - fun: 更有创意和趣味的解读 - normal: 平衡方法,具有良好的运动质量 - spicy: 更有活力和强烈的运动效果 默认值:normal 可选值: fun / normal / spicy。 示例:fun。 |
input.duration | number | 否 | 生成的视频时长(秒)(6-30)。(最小值:6,最大值:30,步长:1) |
input.resolution | string | 否 | 生成视频的分辨率。 默认值:"480p"。 可选值:480p / 720p / 1080p。 示例:480p。 |
input.nsfw_checker | boolean | 否 | 默认 false。为 false 时不额外进行内容过滤,结果由模型直接返回。 |
请求示例
bash
curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
-H "Authorization: Bearer $MODELFOLD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-imagine/text-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "A couple of doors open to the right one by one randomly and stay open, to show the inside, each is either a living room, or a kitchen, or a bedroom or an office, with little people living inside.",
"aspect_ratio": "2:3",
"mode": "normal",
"duration": "6",
"resolution": "480p"
}
}'json
{
"model": "grok-imagine/text-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "A couple of doors open to the right one by one randomly and stay open, to show the inside, each is either a living room, or a kitchen, or a bedroom or an office, with little people living inside.",
"aspect_ratio": "2:3",
"mode": "normal",
"duration": "6",
"resolution": "480p"
}
}响应
200 — 请求成功
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 是 | 请求状态码。请求失败时 HTTP 状态仍为 200,请始终以本字段判断:200 表示成功,其他值均表示失败,原因见 msg。常见值:401 API key 无效或缺失;402 积分不足;429 超出频率限制;422 或 500 请求未能处理(请先查看 msg、检查参数,再决定是否重试)。 可选值:200 / 401 / 402 / 404 / 422 / 429 / 433 / 455 / 500 / 501 / 505。 示例:200。 |
msg | string | 是 | 响应消息,失败时的错误描述 |
data | object | 是 | — |
data.taskId | string | 是 | 可以使用任务 ID 与“获取任务详细信息”端点一起查询任务状态。 |
json
{
"code": 200,
"msg": "success",
"data": {
"taskId": "281e5b0*********************f39b9"
}
}回调
videoTaskCompleted
回调地址:{request.body#/callBackUrl}(即请求体里的 callBackUrl)。
当 grok-imagine/text-to-video 任务成功或失败时,系统会发送此回调。
回调体参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 是 | 统一回调状态码:成功为 200,失败为 501。 可选值:200 / 501。 示例:200。 |
msg | string | 是 | 统一回调消息。 可选值:Playground task completed successfully. / Playground task failed.。 示例:Playground task completed successfully.。 |
data | object | 是 | — |
data.taskId | string | 是 | 任务唯一标识符。 |
data.model | string | 是 | 任务使用的模型。 可选值:grok-imagine/text-to-video。 示例:grok-imagine/text-to-video。 |
data.state | string | 是 | 任务最终状态。 可选值:success / fail。 示例:success。 |
data.param | string | 是 | 包含已提交任务参数的 JSON 字符串。 |
data.resultJson | string | 否 | 任务成功时,包含 resultUrls、firstFrameUrl、lastFrameUrl 或 resultObject 的 JSON 字符串;任务。仅在 state 为 success 时出现。 |
data.failCode | string | 否 | 失败码,数字字符串,如 "400"、"500"。仅在 state 为 fail 时出现。 |
data.failMsg | string | 否 | 失败原因,仅在 state 为 fail 时出现。 |
data.costTime | integer | 否 | 处理耗时(秒),成功和失败回调都会返回。 |
data.completeTime | integer | 否 | 任务完成时间戳。 |
data.createTime | integer | 否 | 任务创建时间戳。 |
data.updateTime | integer | 否 | 完成时间请以 completeTime 为准;updateTime 可能与 createTime 相同。 |
data.creditsConsumed | number | 否 | 本任务消耗的积分;失败任务为 0。 |
任务成功完成
json
{
"code": 200,
"msg": "Playground task completed successfully.",
"data": {
"taskId": "task_example_video_webhook_001",
"model": "grok-imagine/text-to-video",
"state": "success",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A couple of doors open to the right one by one randomly and stay open, to show the inside, each is either a living ro...\\\",\\\"aspect_ratio\\\":\\\"2:3\\\",\\\"mode\\\":\\\"normal\\\",\\\"duration\\\":\\\"6\\\",\\\"resolution\\\":\\\"480p\\\"}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"grok-imagine/text-to-video\"}",
"resultJson": "{\"resultUrls\":[\"https://example.com/generated-video.mp4\"]}",
"costTime": 12,
"completeTime": 1234567890,
"createTime": 1234560000,
"updateTime": 1234567890,
"creditsConsumed": 1.23
}
}任务失败
json
{
"code": 501,
"msg": "Playground task failed.",
"data": {
"taskId": "task_example_video_webhook_001",
"model": "grok-imagine/text-to-video",
"state": "fail",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A couple of doors open to the right one by one randomly and stay open, to show the inside, each is either a living ro...\\\",\\\"aspect_ratio\\\":\\\"2:3\\\",\\\"mode\\\":\\\"normal\\\",\\\"duration\\\":\\\"6\\\",\\\"resolution\\\":\\\"480p\\\"}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"grok-imagine/text-to-video\"}",
"failCode": "400",
"failMsg": "<error detail>",
"costTime": 12,
"creditsConsumed": 0
}
}