创作音乐

Compose a song from a prompt or a composition plan.

请求头

xi-api-keystring可选

查询参数

output_formatenum可选默认为 auto

生成音频的输出格式。格式为 codec_sample_rate_bitrate。使用 “auto”(默认值)可让 API 为所选模型选择最佳格式:v1 模型使用 mp3_44100_128,v2 模型使用 mp3_48000_192。

请求

This endpoint expects an object.
promptstring or null可选<=4100 characters

用于生成歌曲的简单文本提示词。不能与 composition_plan 一起使用。

composition_planobject or null可选

用于指导音乐生成的详细作曲计划。不能与 prompt 一起使用。

music_length_msinteger or null可选3000-600000

要生成的歌曲长度,单位为 ms。仅可与 prompt 一起使用。必须介于 3000ms 和 600000ms 之间。可选;未提供时,模型将根据提示词选择长度。

model_idenum可选默认为 music_v1

用于生成的模型。

允许的值:
seedinteger or null可选0-2147483647

用于初始化音乐生成过程的随机种子。使用相同参数提供相同种子有助于获得更一致的结果,但不保证完全可复现,输出可能会随系统更新而变化。不可与 prompt 同时使用。

force_instrumentalboolean可选默认为 false

如果为 true,确保生成的歌曲为纯音乐。如果为 false,歌曲是否为纯音乐取决于 prompt。只能与 prompt 一起使用。

finetune_idstring or null可选<=100 characters

用于生成的 Finetune ID

respect_sections_durationsboolean可选默认为 true

控制是否严格执行 composition_plan 中各段的时长。仅与 composition_plan 配合使用,且仅适用于 music_v1;对于 music_v2 和 music_v2_5,始终会执行分段时长,此设置将被忽略。对于 music_v1,当值为 false 时,模型可能会调整各段时长,以改善质量和延迟,同时保持计划中的歌曲总时长。

store_for_inpaintingboolean可选默认为 false

是否存储生成的歌曲以供局部重绘。

sign_with_c2paboolean可选默认为 false

是否使用 C2PA 为生成的歌曲签名。仅适用于 mp3 文件。

响应头

song-idstring可选

生成歌曲的唯一标识符。

响应

以指定格式生成的音频文件

错误

422
Unprocessable Entity Error