HappyHorse - 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.
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 happyhorse/text-to-video for this endpoint Default:"happyhorse/text-to-video"。 Allowed values:happyhorse/text-to-video。 示例:happyhorse/text-to-video。 |
callBackUrl | string | No | The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing 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 generation task |
input.prompt | string | Yes | Text prompt describing the video to generate (any language). Up to 5,000 characters. 示例:A miniature city built from cardboard and bottle caps comes to life at night. A cardboard train slowly passes through, with small lights dotting the scene and illuminating the way ahead.。 |
input.resolution | string | No | Output video resolution: 720p or 1080p (default). Default:"1080p"。 Allowed values:720p / 1080p。 示例:1080p。 |
input.aspect_ratio | string | No | Output aspect ratio. Valid values: 16:9 (default), 9:16, 1:1, 4:3, 3:4. Default:"16:9"。 Allowed values:16:9 / 9:16 / 1:1 / 4:3 / 3:4。 示例:16:9。 |
input.duration | integer | No | Output duration in seconds (integer). Must be between 3 and 15. Defaults to 5. Default:5。 示例:5。 |
input.seed | integer | No | Random seed for reproducibility. Default:0。 示例:0。 |
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": "happyhorse/text-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "A miniature city built from cardboard and bottle caps comes to life at night. A cardboard train slowly passes through, with small lights dotting the scene and illuminating the way ahead.",
"resolution": "1080p",
"aspect_ratio": "16:9",
"duration": 5,
"seed": 1622429582
}
}'{
"model": "happyhorse/text-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "A miniature city built from cardboard and bottle caps comes to life at night. A cardboard train slowly passes through, with small lights dotting the scene and illuminating the way ahead.",
"resolution": "1080p",
"aspect_ratio": "16:9",
"duration": 5,
"seed": 1622429582
}
}Response
200 — Request successful
{
"code": 200,
"msg": "success",
"data": {
"taskId": "task_bytedance_1765186743319"
}
}Callback
videoTaskCompleted
Callback URL: {request.body#/callBackUrl} (the callBackUrl in the request body).
The system sends this callback when the happyhorse/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:happyhorse/text-to-video。 示例:happyhorse/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": "happyhorse/text-to-video",
"state": "success",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A miniature city built from cardboard and bottle caps comes to life at night. A cardboard train slowly passes through...\\\",\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5,\\\"seed\\\":1622429582}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse/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": "happyhorse/text-to-video",
"state": "fail",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A miniature city built from cardboard and bottle caps comes to life at night. A cardboard train slowly passes through...\\\",\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5,\\\"seed\\\":1622429582}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse/text-to-video\"}",
"failCode": "400",
"failMsg": "<error detail>",
"costTime": 12,
"creditsConsumed": 0
}
}