生成歌词

本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致；品牌与 API 域名已替换为 ModelFold。

接口

POST /jobs/createTask

完整 URL: https://ai.modelfold.online/v1/jobs/createTask

鉴权：所有请求都需要 Authorization: Bearer <API_KEY> 请求头。

文档已更新

若你此前已完成对接，仍可前往旧版文档查看：旧版地址 (https://ai.modelfold.online/docs/)

根据文本提示生成创意歌词内容。

使用指南

• 使用此接口为音乐创作创建歌词
• 每个请求将生成多个歌词变体
• 每套生成的歌词包括标题和结构化的verse/chorus部分

参数详情

• prompt 应描述所需歌词的主题、风格或题材
• 详细的提示词会产生更有针对性和相关性的歌词

开发者注意事项

• 生成的歌词将保留14天
• 完成时会通过回调一次性返回所有生成的变体
• 通常每个请求会返回2-3种不同的歌词变体
• 每套歌词都按标准部分标记格式化（[Verse], [Chorus]等）
• 轮询 recordInfo 时，歌词在 resultJson.resultObject.lyricsData[]（text、title、status、error_message、tags）。

请求参数

请求体 (application/json)

参数	类型	必填	说明
model	string	是	模型名称 示例：ai-music-api/generate-lyrics。
callBackUrl	string	否	接收生成任务完成更新的 URL。可选但建议在生产环境中使用。 - 当生成完成时，系统将向此 URL POST 任务状态和结果 - 回调包含生成的 URL 和任务信息 - 您的回调端点应接受包含结果的 JSON 负载的 POST 请求 - 或者，使用获取任务详情端点轮询任务状态 - 为确保回调安全性，请参阅 Webhook 校验指南 了解签名验证实现方法 示例：https://api.example.com/callback。
input	object	是	生成任务的输入参数
input.prompt	string	是	对所需歌词内容的描述。具体说明您希望歌词中包含的主题、情绪、风格或故事元素。提示越详细，结果越好。最大字数限制为200字。 示例：一首关于童年回忆和在小镇长大的怀旧歌曲。

请求示例

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/generate-lyrics",
  "callBackUrl": "https://api.example.com/callback",
  "input": {
    "prompt": "A nostalgic song about childhood memories and growing up in a small town"
  }
}'

{
  "model": "ai-music-api/generate-lyrics",
  "callBackUrl": "https://api.example.com/callback",
  "input": {
    "prompt": "A nostalgic song about childhood memories and growing up in a small town"
  }
}

响应

200 — 请求成功

参数	类型	必填	说明
code	integer	否	请求状态码。请求失败时 HTTP 状态仍为 200，请始终以本字段判断：200 表示成功，其他值均表示失败，原因见 msg。常见值：401 API key 无效或缺失；402 积分不足；429 超出频率限制；422 或 500 请求未能处理（请先查看 msg、检查参数，再决定是否重试）。 可选值：200 / 400 / 401 / 404 / 405 / 413 / 429 / 430 / 455 / 500。 示例：200。
msg	string	否	当 code != 200 时的错误信息 示例：success。
data	object	否	—
data.taskId	string	否	任务ID，用于后续查询任务状态 示例：5c79****be8e。

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "5c79****be8e"
  }
}

回调

audioLyricsGenerated

回调地址：{$request.body#/callBackUrl}（即请求体里的 callBackUrl）。

当歌词生成完成时，系统会调用此回调通知结果。

回调示例

{
  "code": 200,
  "data": {
    "callbackType": "complete",
    "data": [
      {
        "error_message": "",
        "status": "complete",
        "text": "[Verse]\n月光洒满了窗台...",
        "title": "星夜狂想"
      }
    ],
    "task_id": "3b66882fde0a5d398bd269cab6d9542b"
  },
  "msg": "All generated successfully."
}

回调体参数

参数	类型	必填	说明
code	integer	否	状态码 示例：200。
msg	string	否	返回消息 示例：All generated successfully。
data	object	否	—
data.callbackType	string	否	回调类型，固定为 complete 可选值：complete。 示例：complete。
data.task_id	string	否	任务ID
data.data	array<object>	否	生成的歌词列表
data.data[].text	string	否	歌词内容
data.data[].title	string	否	歌词标题
data.data[].status	string	否	生成状态 可选值：complete / failed。 示例：complete。
data.data[].error_message	string	否	错误信息，仅当状态为 failed 时有值

{
  "code": 200,
  "msg": "All generated successfully",
  "data": {
    "callbackType": "complete",
    "task_id": "",
    "data": [
      {
        "text": "A serene mountain landscape at sunrise",
        "title": "",
        "status": "complete",
        "error_message": "A serene mountain landscape at sunrise"
      }
    ]
  }
}