> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poyo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 生成 Persona

> 从现有音轨创建可复用的音乐 Persona

> [!TIP]
>
> 1. 提交后会返回 `task_id`。如果提供了 `callback_url`，当任务状态变为 `finished` 或 `failed` 时，系统会向 `callback_url` 发送 POST 请求。
> 2. 无论是否提供 `callback_url`，都可以通过统一的[查询音乐详情](https://docs.poyo.ai/zh/api-manual/music-series/query-music-detail.md)接口获取结果。

可选的 `vocal_start` 和 `vocal_end` 用于选取 10–30 秒的源音频片段，必须同时提供。`style` 可用于描述期望的 Persona 风格。

## 使用指南

* 此接口从现有音轨创建可复用的音乐 Persona
* Persona 会捕捉人声风格、流派特征和音乐个性
* 创建后，可通过 `persona_id` 参数在生成音乐和延长音乐接口中使用 Persona

## 参数详情

* `task_id`（必填）：已完成的[生成](https://docs.poyo.ai/zh/api-manual/music-series/generate-music.md)或[延长](https://docs.poyo.ai/zh/api-manual/music-series/extend-music.md)任务的任务 ID
* `audio_id`（必填）：回调数据中具体音轨的标识
* `name`（必填）：体现音乐风格或特点的描述性名称
* `description`（必填）：详细描述，包括：
  * 流派和情绪
  * 配器偏好
  * 人声特征
  * 独特的音乐个性特点

## 开发者说明

* 每条音轨只能创建一个 Persona
* 如果该音频已存在 Persona，API 返回错误码 409
* 你可以在以下接口中使用 `persona_id`：
  * [生成音乐](https://docs.poyo.ai/zh/api-manual/music-series/generate-music.md)
  * [延长音乐](https://docs.poyo.ai/zh/api-manual/music-series/extend-music.md)
* 提供详细的描述，以便使用 Persona 时获得最佳效果


## OpenAPI

````yaml zh/api-manual/music-series/generate-persona.json POST /api/generate/submit
openapi: 3.1.0
info:
  title: PoYo AI - 生成 Persona API
  description: 从现有音轨创建可复用的音乐 Persona
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Persona
      summary: 提交生成 Persona 任务
      description: 从现有音轨创建一个可复用的音乐 Persona
      operationId: submitGeneratePersonaTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              jazz-persona:
                summary: 创建爵士歌手 Persona
                value:
                  model: generate-persona
                  callback_url: https://your-domain.com/callback
                  input:
                    task_id: 5c79xxxxbe8e
                    audio_id: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
                    name: Smooth Jazz Singer
                    description: >-
                      A sultry jazz vocalist with smooth, mellow tones.
                      Specializes in late-night jazz ballads with piano
                      accompaniment and warm, intimate delivery.
              rock-persona:
                summary: 创建摇滚乐队 Persona
                value:
                  model: generate-persona
                  callback_url: https://your-domain.com/callback
                  input:
                    task_id: 5c79xxxxbe8e
                    audio_id: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
                    name: Electric Rock Band
                    description: >-
                      High-energy rock band with powerful guitar riffs, driving
                      drums, and passionate vocals. Perfect for anthemic rock
                      songs and energetic performances.
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '409':
          description: Persona 已存在
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 409
                error:
                  message: Persona already exists for this audio
                  type: conflict_error
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: |-
            API 模型标识符。

            此接口必须为 `generate-persona`。
          enum:
            - generate-persona
          example: generate-persona
        callback_url:
          type: string
          format: uri
          description: 接收结果通知的 Webhook 回调 URL
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - task_id
            - audio_id
            - name
            - description
          description: Persona 生成的输入参数
          properties:
            task_id:
              type: string
              description: 已完成的 Generate Music 或 Extend Music 任务的唯一标识符。
              example: 5c79xxxxbe8e
            audio_id:
              type: string
              description: |-
                要创建 Persona 的音轨唯一标识符。

                音乐生成完成后，此 ID 会在回调数据中返回。
              example: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
            name:
              type: string
              pattern: \S
              description: |-
                Persona 的描述性名称。

                应体现该 Persona 的音乐风格或特点。
              example: Smooth Jazz Singer
            description:
              type: string
              pattern: \S
              description: |-
                Persona 音乐特征、风格和个性的详细描述。

                包括流派、情绪、配器、人声风格及任何独特特征。
              example: >-
                A sultry jazz vocalist with smooth, mellow tones. Specializes in
                late-night jazz ballads with piano accompaniment.
            vocal_start:
              type: number
              minimum: 0
              description: 10-30 秒片段的开始时间；需要同时提供 vocal_end。
            vocal_end:
              type: number
              minimum: 0
              description: 片段的结束时间；需要同时提供 vocal_start，必须大于 vocal_start，且所选区间须为 10-30 秒。
            style:
              type: string
              description: 可选，期望的 Persona 风格。
          dependentRequired:
            vocal_start:
              - vocal_end
            vocal_end:
              - vocal_start
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
              description: 任务唯一标识，用于查询任务状态
            status:
              type: string
              enum:
                - not_started
                - running
                - finished
                - failed
              example: not_started
              description: >-
                任务状态。提交后立即返回时始终为
                `not_started`。后续状态请通过[查询任务状态](/zh/api-manual/task-management/status)接口或
                `callback_url` 获取。


                - `not_started`：排队中，等待处理

                - `running`：生成中

                - `finished`：已完成，结果在 `files` 或 `output` 中

                - `failed`：失败，详情见 `error_message`
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: 任务创建时间，ISO 8601 格式
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
              description: 描述错误原因的错误信息
            type:
              type: string
              example: invalid_request_error
              description: 错误类型标识
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        所有 API 接口都需要 Bearer Token 认证。


        创建 API Key：登录 PoYo，进入 **仪表盘 → API
        密钥**（[poyo.ai/zh/dashboard/api-key](https://poyo.ai/zh/dashboard/api-key)），点击创建
        Key。


        在请求头中添加：


        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.