生成声音
本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致;品牌与 API 域名已替换为 ModelFold。
接口
POST /jobs/createTask
完整 URL: https://ai.modelfold.online/v1/jobs/createTask
鉴权:所有请求都需要
Authorization: Bearer <API_KEY>请求头。
文档已更新
若你此前已完成对接,仍可前往旧版文档查看:旧版地址 (https://ai.modelfold.online/docs/)
用于创建声音生成任务(Sounds Task)。支持设置循环、节拍(BPM)、音调(Key)以及歌词字幕抓取等功能。
🚀 使用指南
- 使用该接口可根据输入的
prompt生成对应的声音内容 - 支持设置循环播放效果,适合背景音乐、环境音等场景
- 支持指定 BPM(每分钟节拍数)和音调(Key),便于控制生成结果风格
- 可选开启歌词字幕抓取,便于后续展示或处理歌词内容
- 支持通过回调地址异步接收任务完成通知
📌 使用场景
- 🎧 背景音乐创作
- 🎮 游戏音效或循环环境音生成
- 🌐 音频内容平台与创作工具集成
轮询 GET /api/v1/jobs/recordInfo 时,结果在 data.response.data[](audio_url、stream_audio_url、image_url、id、duration)。
请求参数
请求体 (application/json)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型名称 示例:ai-music-api/sounds。 |
callBackUrl | string | 否 | 接收生成任务完成更新的 URL。可选但建议在生产环境中使用。 - 当生成完成时,系统将向此 URL POST 任务状态和结果 - 回调包含生成的 URL 和任务信息 - 您的回调端点应接受包含结果的 JSON 负载的 POST 请求 - 或者,使用获取任务详情端点轮询任务状态 - 为确保回调安全性,请参阅 Webhook 校验指南 了解签名验证实现方法 |
input | object | 是 | 生成任务的输入参数 |
input.prompt | string | 是 | 声音描述(最多 500 字符)。 |
input.model | string | 是 | 必填。请使用 V6、V6_MINI 或 V6_WILD。 - V6_WILD:突破风格边界,带来更大胆、更独特的音乐表达。- V6_MINI:轻量快速,兼顾音质与效率,灵感创作更简单。- V6:更强的音乐表现力,更自然的人声与丰富细节 可选值:V5 / V5_5 / V6 / V6_WILD / V6_MINI。 示例:V6。 |
input.sound_loop | boolean | 否 | 是否循环 默认值:false。 示例:false。 |
input.sound_tempo | integer | 否 | 不传就是Auto 默认值:null。 |
input.sound_key | string | 否 | 调性,默认 "Any"(自动)。 默认值:"Any"。 可选值:Any / Cm / C#m / Dm / D#m / Em / Fm / F#m / Gm / G#m / Am / A#m / Bm / C / C# / D / D# / E / F / F# / G / G# / A / A# / B。 示例:Any。 |
input.grab_lyrics | boolean | 否 | 是否抓取歌词字幕 完成后是否调用接口获取歌词字幕 |
请求示例
bash
curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
-H "Authorization: Bearer $MODELFOLD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "ai-music-api/sounds",
"callBackUrl": "https://api.example.com/callback",
"input": {
"prompt": "sint",
"model": "V6",
"sound_loop": true,
"sound_tempo": 166,
"sound_key": "D#m",
"grab_lyrics": true
}
}'json
{
"model": "ai-music-api/sounds",
"callBackUrl": "https://api.example.com/callback",
"input": {
"prompt": "sint",
"model": "V6",
"sound_loop": true,
"sound_tempo": 166,
"sound_key": "D#m",
"grab_lyrics": true
}
}响应
200 — 请求成功
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 否 | 请求状态码。请求失败时 HTTP 状态仍为 200,请始终以本字段判断:200 表示成功,其他值均表示失败,原因见 msg。常见值:401 API key 无效或缺失;402 积分不足;429 超出频率限制;422 或 500 请求未能处理(请先查看 msg、检查参数,再决定是否重试)。 可选值:200 / 401 / 402 / 404 / 409 / 422 / 429 / 451 / 455 / 500。 示例:200。 |
msg | string | 否 | 当 code != 200 时的错误消息 示例:success。 |
data | object | 否 | — |
data.taskId | string | 否 | 用于跟踪任务状态的任务ID。使用此ID与"获取音乐详情"接口查询任务详情和结果。 示例:5c79****be8e。 |
json
{
"code": 200,
"msg": "success",
"data": {
"taskId": "5c79****be8e"
}
}