跳到主要内容

作曲

POST 

https://api.knoxstudio.ai/v1/music

生成歌曲并返回音频文件。发送 prompt 或 composition_plan,不能同时使用。按 每生成分钟 $0.20 计费。流程见 音乐生成。

请求​

查询参数​

名称类型必填描述
output_formatString否默认 auto。允许值:auto, mp3_48000_128, mp3_48000_192, mp3_48000_240, mp3_48000_320, mp3_22050_32, mp3_24000_48, mp3_44100_32, mp3_44100_64, mp3_44100_96, mp3_44100_128, mp3_44100_192, pcm_8000, pcm_16000, pcm_22050, pcm_24000, pcm_32000, pcm_44100, pcm_48000, ulaw_8000, alaw_8000, opus_48000_32, opus_48000_64, opus_48000_96, opus_48000_128, opus_48000_192。

请求头​

名称类型必填描述
AuthorizationString是Bearer <token> Knox API key。也接受 xi-api-key。
Content-TypeString是application/json。

请求体​

名称类型必填描述
promptString条件文本提示。不能与 composition_plan 同时使用。
composition_planObject条件来自 POST /v1/music/plan 的结构化计划。不能与 prompt 同时使用。
music_length_msInteger否时长(毫秒),3000–300000。仅与 prompt 一起使用。Knox 上限 5 分钟。
model_idString否music_v1(默认)、music_v2 或 music_v2_5。
seedInteger否确定性提示。不能与 prompt 同时使用。
force_instrumentalBoolean否为 true 时无人声。仅与 prompt 一起使用。默认 false。
finetune_idString否可选微调,见 /v1/music/finetunes。
respect_sections_durationsBoolean否强制计划段落时长。仅 music_v1;v2 / v2.5 忽略。默认 true。
store_for_inpaintingBoolean否存储歌曲供后续局部重绘。默认 false。
sign_with_c2paBoolean否为 MP3 输出签名 C2PA。默认 false。

cURL 示例​

curl -X POST "https://api.knoxstudio.ai/v1/music?output_format=mp3_44100_128" \
-H "Authorization: Bearer $KNOXCHAT_API_KEY" \
-H "Content-Type: application/json" \
-o song.mp3 \
-d '{
"model_id": "music_v2_5",
"prompt": "An upbeat indie-pop song about a night drive",
"music_length_ms": 60000
}'

响应​

成功响应 (200)​

生成的音频文件。Content-Type 随 output_format(默认 MP3)。用于局部重绘的歌曲 ID 会出现在响应头中。

按每生成分钟 $0.20 计费(仅提示且未设 music_length_ms 时,在得知实际时长前按 30 秒估算)。

错误响应​

校验失败返回 HTTP 422:

{
"detail": [
{
"loc": ["body", "field"],
"msg": "…",
"type": "value_error"
}
]
}

其他错误使用 { "detail": "message" }。

状态何时
400未携带 Upgrade: websocket 访问 WebSocket 路径。
401缺少或无效的 API key。
402余额不足。
403Token 无权使用该模型。
404资源不存在。
422校验错误。
429超出速率限制。
500服务器内部错误。