跳转到主要内容
POST
/
api
/
v1
/
generate
/
generate-persona
生成 Persona
curl --request POST \
  --url https://api.api.box/api/v1/generate/generate-persona \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "taskId": "5c79****be8e",
  "audioId": "e231****-****-****-****-****8cadc7dc",
  "name": "电子流行歌手",
  "description": "具有现代电子音乐风格的流行歌手，擅长动感节奏和合成器音色"
}
'
{
  "code": 200,
  "msg": "success",
  "data": {
    "personaId": "a1b2****c3d4",
    "name": "电子流行歌手",
    "description": "具有现代电子音乐风格的流行歌手，擅长动感节奏和合成器音色"
  }
}

​
使用指南

  • 此接口用于为已生成的音乐创建 Persona（音乐角色）
  • 需要提供来自音乐生成相关接口（生成、扩展、翻唱、上传扩展）的 taskId 和音频ID
  • 可以自定义 Persona 的名称和描述，为音乐赋予独特的个性
  • 生成的 Persona 可用于后续的音乐创作和风格迁移

​
参数详情

  • taskId: 必需参数，指定原始音乐生成任务的唯一标识符。可以是以下接口返回的 taskId：
  • audioId: 必需参数，指定要创建 Persona 的音频ID
  • name: 必需参数，为 Persona 指定一个易于识别的名称
  • description: 必需参数，描述 Persona 的音乐特征、风格和个性

​
开发者注意事项

  • 重要提示：调用此接口前请确保音乐生成任务已完全完成。如果音乐正在生成中时调用此接口将会返回失败
  • 模型要求：Persona 生成仅支持使用 V4 以上版本模型生成的音乐的 taskId
  • 建议为 Persona 提供详细的描述，以便更好地捕捉音乐特征
  • 返回的 personaId 可以用于后续的音乐生成请求中，以创作具有相似风格特征的音乐
  • 你可以将 personaId 应用到以下接口：
  • 每个音频只能生成一次 Persona

​
参数示例

{
  "taskId": "5c79****be8e",
  "audioId": "e231****-****-****-****-****8cadc7dc",
  "name": "电子流行歌手",
  "description": "具有现代电子音乐风格的流行歌手，擅长动感节奏和合成器音色"
}
确保使用的 taskId 对应的音乐生成任务已完成，且 audioId 是有效的。
为 Persona 提供详细而具体的描述可以帮助系统更准确地捕捉音乐风格特征。

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
​
taskId
string
required

原始音乐生成任务的唯一标识符。可以是以下任一接口返回的 taskId：

  • 生成音乐 (/api/v1/generate)
  • 扩展音乐 (/api/v1/generate/extend)
  • 上传并翻唱音频 (/api/v1/generate/upload-cover)
  • 上传并扩展音频 (/api/v1/generate/upload-extend)
Example:

"5c79****be8e"

​
audioId
string
required

要创建 Persona 的音乐轨道的音频ID。此ID可以从音乐生成响应中获取。

Example:

"e231****-****-****-****-****8cadc7dc"

​
name
string
required

Persona 的名称。一个能够捕捉音乐风格或角色本质的描述性名称。

Example:

"电子流行歌手"

​
description
string
required

Persona 的音乐特征、风格和个性的详细描述。请具体说明流派、情绪、乐器使用和人声特质。

Example:

"具有现代电子音乐风格的流行歌手，擅长动感节奏和合成器音色"

Response

请求成功

​
code
enum<integer>

响应状态码

  • 200: 成功 - 请求已成功处理
  • 401: 未授权 - 身份验证凭据缺失或无效
  • 402: 积分不足 - 账户没有足够的积分执行此操作
  • 404: 未找到 - 请求的资源或端点不存在
  • 409: 冲突 - 该音乐的 Persona 已存在
  • 422: 验证错误 - 请求参数未通过验证检查
  • 429: 超出限制 - 已超过对此资源的请求限制
  • 451: 未授权 - 获取音乐数据失败。请验证您或您的服务提供商设置的任何访问限制。
  • 455: 服务不可用 - 系统当前正在进行维护
  • 500: 服务器错误 - 处理请求时发生意外错误
可用选项:
200,
401,
402,
404,
409,
422,
429,
451,
455,
500
​
msg
string

当 code != 200 时的错误信息

Example:

"success"

​
data
object