Grok Imagine Text to Video
This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.
Endpoint
POST /jobs/createTask
Full URL: https://ai.modelfold.online/v1/jobs/createTask
Authentication: every request must include the
Authorization: Bearer <API_KEY>header.
Output is an MP4 video with an audio track generated together with the video (dialogue written in the prompt is spoken). Audio cannot be turned off.
Query Task Status
After submitting a task, use the unified query endpoint to check progress and retrieve results:
- Get Task Details — Learn how to query task status and retrieve generation results
TIP
For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint
Related Resources
- Market Overview — Explore all available models
- Common API — Check credits and account usage
Request Parameters
Body (application/json)
| Parameter | Type | Required | Description |
|---|---|---|---|
model | string | Yes | The model name to use for generation. Required field. - Must be grok-imagine/text-to-video for this endpoint Default:"grok-imagine/text-to-video"。 Allowed values:grok-imagine/text-to-video。 示例:grok-imagine/text-to-video。 |
callBackUrl | string | No | The URL to receive video generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when video generation completes - Callback includes generated video URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing video results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例: https://your-domain.com/api/callback。 |
input | object | Yes | Input parameters for the video generation task |
input.prompt | string | Yes | Text prompt describing the desired video motion. Required field. - Should be detailed and specific about the desired visual motion - Describe movement, action sequences, camera work, and timing - Include details about subjects, environments, and motion dynamics - Maximum length: 5000 characters - Supports English language prompts 示例: 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.。 |
input.aspect_ratio | string | No | Specifies the width-to-height ratio of the generated video. Controls the aspect ratio of the output. - 2:3: Portrait orientation (vertical) - 3:2: Landscape orientation (horizontal) - 1:1: Square format - 16:9: Wide screen format - 9:16: Tall screen format Default: 2:3 Default: "2:3"。 Allowed values:2:3 / 3:2 / 1:1 / 16:9 / 9:16。 示例:2:3。 |
input.mode | string | No | Specifies the generation mode affecting the style and intensity of motion. - fun: More creative and playful interpretation - normal: Balanced approach with good motion quality - spicy: More dynamic and intense motion effects Default: normal Default: "normal"。 Allowed values:fun / normal / spicy。 示例:normal。 |
input.duration | number | No | The duration of the generated video (in seconds) (6-30). (Minimum: 6, Maximum: 30, Step: 1) |
input.resolution | string | No | The resolution of the generated video. Default:"480p"。 Allowed values:480p / 720p / 1080p。 示例:480p。 |
input.nsfw_checker | boolean | No | Defaults to false. When false, no additional content filtering is applied and results are returned directly by the model. |
Request Example
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"
}
}'{
"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"
}
}Response
200 — Request successful
{
"code": 200,
"msg": "success",
"data": {
"taskId": "281e5b0*********************f39b9"
}
}Callback
videoTaskCompleted
Callback URL: {request.body#/callBackUrl} (the callBackUrl in the request body).
The system sends this callback when the grok-imagine/text-to-video task succeeds or fails.
Callback body parameters
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 是 | Unified callback code: 200 for success, 501 for failure. Allowed values:200 / 501。 示例:200。 |
msg | string | 是 | Unified callback message. Allowed values:Playground task completed successfully. / Playground task failed.。 示例:Playground task completed successfully.。 |
data | object | 是 | — |
data.taskId | string | 是 | The unique task identifier. |
data.model | string | 是 | The model used for the task. Allowed values:grok-imagine/text-to-video。 示例:grok-imagine/text-to-video。 |
data.state | string | 是 | Terminal task state. Allowed values:success / fail。 示例:success。 |
data.param | string | 是 | JSON string containing the submitted task parameters. |
data.resultJson | string | 否 | JSON string containing resultUrls, firstFrameUrl, lastFrameUrl, or resultObject when successful. Present only when state is success. |
data.failCode | string | 否 | Failure code, a numeric string such as "400" or "500". Present only when state is fail. |
data.failMsg | string | 否 | Failure reason. Present only when state is fail. |
data.costTime | integer | 否 | Processing time in seconds. Present on both success and failure callbacks. |
data.completeTime | integer | 否 | Task completion timestamp. |
data.createTime | integer | 否 | Task creation timestamp. |
data.updateTime | integer | 否 | Use completeTime as the completion time; updateTime may equal createTime. |
data.creditsConsumed | number | 否 | Credits consumed by the task; 0 for failed tasks. |
Task completed successfully
{
"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
}
}Task failed
{
"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
}
}