HappyHorse-参考生视频
本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致;品牌与 API 域名已替换为 ModelFold。
接口
POST /jobs/createTask
完整 URL: https://ai.modelfold.online/v1/jobs/createTask
鉴权:所有请求都需要
Authorization: Bearer <API_KEY>请求头。
查询任务状态
提交任务后,可通过统一的查询接口查看任务进度并获取结果:
- Get Task Details — 了解如何查询任务状态并获取生成结果
TIP
生产环境中,建议使用 callBackUrl 参数接收生成完成的自动通知,而非轮询状态接口。
相关资源
- Market Overview — 浏览所有可用模型
- Common API — 查看账户积分与使用情况
请求参数
请求体 (application/json)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 用于生成任务的模型名称。必填字段。 - 该接口必须使用 happyhorse/reference-to-video 模型 默认值:"happyhorse/reference-to-video"。 可选值:happyhorse/reference-to-video。 示例:happyhorse/reference-to-video。 |
callBackUrl | string | 否 | 接收生成任务完成通知的回调 URL。可选配置,生产环境建议使用。 - 任务生成完成后,系统会向该 URL 以 POST 方式推送任务状态和结果 - 回调内容包含生成内容的 URL 及任务相关信息 - 你的回调接口需支持接收 POST 请求及 JSON 格式的请求体 - 也可选择调用任务详情接口,主动轮询任务状态 示例: https://your-domain.com/api/callback。 |
input | object | 是 | 生成任务的输入参数 |
input.prompt | string | 是 | 用于描述视频内容,并用 character1/character2/... 指代参考图中的角色/主体。 示例:身着红色旗袍的女性character1,镜头先以侧面中景勾勒旗袍修身剪裁与S型曲线,随即切换至低角度仰拍,捕捉她轻抬玉手展开折扇character2时流苏耳坠character3随头部转动轻盈摆动的细节,最后推近至面部特写,定格在她指尖轻点扇骨、眼波流转间的含蓄风情,多视角全方位展现东方韵味。。 |
input.reference_image | array<string> | 是 | 参考图片 URL 列表(顺序很重要,对应 character1、character2...)。图像限制:格式:JPEG、JPG、PNG、WEBP。分辨率:短边不低于400像素,推荐720P以上清晰图。避免传入过小、模糊或压缩过度的图像,影响效果。文件大小:不超过10MB。 |
input.resolution | string | 否 | 输出视频分辨率。 默认值:"1080p"。 可选值:720p / 1080p。 示例:1080p。 |
input.aspect_ratio | string | 否 | 输出视频宽高比。 默认值:"16:9"。 可选值:16:9 / 9:16 / 1:1 / 4:3 / 3:4。 示例:16:9。 |
input.duration | integer | 否 | 输出视频时长(单位:秒)。取值 3–15 的整数,默认 5。 默认值:5。 示例:5。 |
input.seed | integer | 否 | 随机种子。 |
请求示例
bash
curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
-H "Authorization: Bearer $MODELFOLD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "happyhorse/reference-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "身着红色旗袍的女性character1,镜头先以侧面中景勾勒旗袍修身剪裁与S型曲线,随即切换至低角度仰拍,捕捉她轻抬玉手展开折扇character2时流苏耳坠character3随头部转动轻盈摆动的细节,最后推近至面部特写,定格在她指尖轻点扇骨、眼波流转间的含蓄风情,多视角全方位展现东方韵味。",
"reference_image": [
"https://example.com/your-image.png",
"https://example.com/your-image.png"
],
"resolution": "1080p",
"aspect_ratio": "16:9",
"duration": 5,
"seed": 1851569351
}
}'json
{
"model": "happyhorse/reference-to-video",
"callBackUrl": "https://your-domain.com/api/callback",
"input": {
"prompt": "身着红色旗袍的女性character1,镜头先以侧面中景勾勒旗袍修身剪裁与S型曲线,随即切换至低角度仰拍,捕捉她轻抬玉手展开折扇character2时流苏耳坠character3随头部转动轻盈摆动的细节,最后推近至面部特写,定格在她指尖轻点扇骨、眼波流转间的含蓄风情,多视角全方位展现东方韵味。",
"reference_image": [
"https://example.com/your-image.png",
"https://example.com/your-image.png"
],
"resolution": "1080p",
"aspect_ratio": "16:9",
"duration": 5,
"seed": 1851569351
}
}响应
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": "task_bytedance_1765186743319"
}
}回调
videoTaskCompleted
回调地址:{request.body#/callBackUrl}(即请求体里的 callBackUrl)。
当 happyhorse/reference-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 | 是 | 任务使用的模型。 可选值:happyhorse/reference-to-video。 示例:happyhorse/reference-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": "happyhorse/reference-to-video",
"state": "success",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A woman in a red qipao character1. The shot opens with a side medium view outlining the tailored fit of the qipao and...\\\",\\\"reference_image\\\":[\\\"https://example.com/input-image.jpg\\\"],\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5,\\\"seed\\\":1308038620}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse/reference-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": "happyhorse/reference-to-video",
"state": "fail",
"param": "{\"input\":\"{\\\"prompt\\\":\\\"A woman in a red qipao character1. The shot opens with a side medium view outlining the tailored fit of the qipao and...\\\",\\\"reference_image\\\":[\\\"https://example.com/input-image.jpg\\\"],\\\"resolution\\\":\\\"1080p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5,\\\"seed\\\":1308038620}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"happyhorse/reference-to-video\"}",
"failCode": "400",
"failMsg": "<error detail>",
"costTime": 12,
"creditsConsumed": 0
}
}