跳转到主要内容
POST
/
api
/
v1
/
lyrics
生成歌词
curl --request POST \
  --url https://api.api.box/api/v1/lyrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "一首关于城市宁静夜晚的歌",
  "callBackUrl": "https://api.example.com/callback"
}'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "5c79****be8e"
  }
}

使用指南

  • 此接口仅根据您的提示生成歌词内容
  • 将返回多个歌词变体供您选择
  • 生成的歌词通常包含歌曲结构标记(例如[Verse]、[Chorus])

开发者注意事项

  1. 生成的歌词将保留15天
  2. 回调只有一个阶段:complete(生成完成)
  3. 当您只需要创建歌词而不需要音乐时使用此接口
  4. 结果可以作为自定义模式下生成音乐接口的输入

Authorizations

Authorization
string
header
required

🔑 API 认证说明

所有接口都需要通过 Bearer Token 方式进行认证。

获取 API Key

  1. 访问 API Key 管理页面 获取您的 API Key

使用方式

在请求头中添加:

Authorization: Bearer YOUR_API_KEY

⚠️ 注意:

  • 请妥善保管您的 API Key,不要泄露给他人
  • 如果怀疑 API Key 泄露,请立即在管理页面重置

Body

application/json
prompt
string
required

详细描述期望的歌词内容。

  • 具体说明您想要的主题、情绪、风格和歌曲结构。
  • 提示越详细,生成的歌词就越符合您的构想。
  • 最大字数限制为200字。
Example:

"一首关于城市宁静夜晚的歌"

callBackUrl
string<uri>
required

接收歌词生成结果的URL。

  • 必填。
  • 与音乐生成不同,歌词回调只有一个阶段:complete(生成完成)。

详细的回调格式和实现指南,请参见 歌词生成回调

  • 或者,您也可以使用获取歌词生成详情接口来轮询任务状态
Example:

"https://api.example.com/callback"

Response

请求成功

code
enum<integer>

状态码说明

  • ✅ 200 - 请求成功
  • ⚠️ 400 - 参数错误
  • ⚠️ 401 - 没有访问权限
  • ⚠️ 404 - 请求方式或者路径错误
  • ⚠️ 405 - 调用超过限制
  • ⚠️ 413 - 主题或者prompt过长
  • ⚠️ 429 - 积分不足
  • ⚠️ 430 - 您的调用频率过高。请稍后再试。
  • ⚠️ 455 - 网站维护
  • ❌ 500 - 服务器异常
Available options:
200,
400,
401,
404,
405,
413,
429,
430,
455,
500
Example:

200

msg
string

当 code != 200 时,展示错误信息

Example:

"success"

data
object
I