HappyHorse-1-1 reference-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 the task, you can check the progress of the task and obtain the generated results through the unified query endpoint:

• Get Task Details — Learn how to check the task status and obtain the generated results

TIP

In the production environment, it is recommended to use the "callBackUrl" parameter to receive the automatic notification upon completion of the generation, rather than polling the status endpoint.

Related resources

• Market Overview — View all available models
• General API — View account credits and usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
model	string	Yes	The model name used for generation. This endpoint must use happyhorse-1-1/reference-to-video. Default："happyhorse-1-1/reference-to-video"。 Allowed values：happyhorse-1-1/reference-to-video。 示例：happyhorse-1-1/reference-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	A description of the desired elements and visual style for the generated video. Input in any language is supported. Up to 5,000 characters. Use "[Image 1]", "[Image 2]" to refer to the images in reference_image, in the same order. When using a reference, specify the object in the image, such as "the woman in a red qipao in [Image 1]". 示例：A cat running on the grass。
input.reference_image	array<string>	Yes	The URL of a reference image. Image requirements: 1. Formats: JPEG, JPG, PNG, WEBP. 2. Resolution: The shortest side must be at least 400 pixels. A clear image with a resolution of 720P or higher is recommended. Avoid using images that are too small, blurry, or overly compressed, as this can degrade the output quality. 3. Maximum file size: 20 MB.
input.resolution	string	No	The resolution tier of the generated video. Options: 720p; 1080p Default："1080p"。 Allowed values：720p / 1080p。 示例：1080p。
input.aspect_ratio	string	No	The aspect ratio of the generated video. Options: 16:9; 9:16; 3:4; 4:3; 4:5; 5:4; 1:1; 9:21; 21:9 Default："16:9"。 Allowed values：16:9 / 9:16 / 3:4 / 4:3 / 4:5 / 5:4 / 1:1 / 9:21 / 21:9。 示例：16:9。
input.duration	number	No	The duration of the generated video, in seconds. Value range: An integer from 3 to 15. Default：5。 示例：5。

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-1-1/reference-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "reference_image": [
      "https://static.aiquickdraw.com/tools/example/1782114387854_IufKnPxR.png"
    ],
    "prompt": "A cat running on the grass",
    "resolution": "1080p",
    "aspect_ratio": "16:9",
    "duration": 5
  }
}'

{
  "model": "happyhorse-1-1/reference-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "reference_image": [
      "https://static.aiquickdraw.com/tools/example/1782114387854_IufKnPxR.png"
    ],
    "prompt": "A cat running on the grass",
    "resolution": "1080p",
    "aspect_ratio": "16:9",
    "duration": 5
  }
}

Response

200 — Request Successful

参数	类型	必填	说明
code	integer	否	Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). 可选值：200 / 401 / 402 / 404 / 422 / 429 / 433 / 455 / 500 / 501 / 505。 示例：200。
msg	string	否	Response message, error description upon failure 示例：success。
data	object	是	—
data.taskId	string	是	The task ID can be used with the "Get Task Details" endpoint to query the task status. 示例：dc1928bfcbc77cb6c85f3359a9c718b3。

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_254_abc123"
  }
}

Callback

videoTaskCompleted

Callback URL: {request.body#/callBackUrl} (the callBackUrl in the request body).

The system sends this callback when the happyhorse-1-1/reference-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-1-1/reference-to-video。 示例：happyhorse-1-1/reference-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-1-1/reference-to-video",
    "state": "success",
    "param": "{\"input\":\"{\\\"reference_image\\\":[\\\"https://example.com/input-image.jpg\\\"],\\\"prompt\\\":\\\"A cat running on the grass\\\",\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse-1-1/reference-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-1-1/reference-to-video",
    "state": "fail",
    "param": "{\"input\":\"{\\\"reference_image\\\":[\\\"https://example.com/input-image.jpg\\\"],\\\"prompt\\\":\\\"A cat running on the grass\\\",\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse-1-1/reference-to-video\"}",
    "failCode": "400",
    "failMsg": "<error detail>",
    "costTime": 12,
    "creditsConsumed": 0
  }
}