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

# 添加伴奏

> 为上传的音频文件生成伴奏

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

## 使用指南

* 此接口为上传的音频文件生成伴奏
* 通常用于人声分轨或旋律，以制作伴奏音轨
* 无需制作人，即可为现有录音添加伴奏层

## 参数详情

* 必填参数：

  * `upload_url`：要处理的音频文件 URL

  * `title`：生成曲目的名称

  * `tags`：期望的音乐风格（例如 "relaxing, piano, soothing"）

  * `negative_tags`：要排除的风格（例如 "heavy metal, fast drums"）

* 模型选择：

  * **V5**：音乐表现力更出色，生成更快

  * **V4\_5PLUS**：音色更丰富（默认）

## 使用说明

* 使用描述性的标签引导伴奏风格
* 结合正向和负向标签，精确控制输出
* 回调机制会在三个阶段发送通知：文本生成、第一首曲目完成、全部曲目完成

## 可选参数

* `model` (string)：AI 模型版本。可选值：`V4_5PLUS`（默认）、`V5`。

* `vocal_gender` (string)：人声性别偏好。`m` 为男声，`f` 为女声。注意：此参数只能提高概率，无法保证生成指定性别的人声。

* `style_weight` (number)：遵循风格的强度。取值 0-1，最多 2 位小数。

* `weirdness_constraint` (number)：控制创意偏离程度。取值 0-1，最多 2 位小数。

* `audio_weight` (number)：音频特征的平衡权重。取值 0-1，最多 2 位小数。


## OpenAPI

````yaml zh/api-manual/music-series/add-instrumental.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Add Instrumental API
  description: 为上传的音频文件生成伴奏
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Music Generation
      summary: 提交添加伴奏任务
      description: 为上传的音频文件（通常是人声分轨或旋律）生成伴奏
      operationId: submitAddInstrumentalTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              basic:
                summary: 基础伴奏生成
                value:
                  model: add-instrumental
                  callback_url: https://your-domain.com/callback
                  input:
                    upload_url: https://cdn.vidgo.ai/temp/vocals.mp3
                    title: 舒缓钢琴
                    tags: relaxing, piano, soothing
                    negative_tags: heavy metal, fast drums
              advanced:
                summary: 高级风格控制
                value:
                  model: add-instrumental
                  callback_url: https://your-domain.com/callback
                  input:
                    upload_url: https://cdn.vidgo.ai/temp/vocals.mp3
                    mv: V5
                    title: 史诗管弦乐背景
                    tags: orchestral, cinematic, epic
                    negative_tags: electronic, synth
                    vocal_gender: m
                    style_weight: 0.7
                    weirdness_constraint: 0.3
                    audio_weight: 0.65
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          example: add-instrumental
        callback_url:
          type: string
          format: uri
          description: 接收结果通知的 Webhook 回调 URL
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - upload_url
            - title
            - tags
            - negative_tags
          description: 伴奏生成的输入参数
          properties:
            upload_url:
              type: string
              format: uri
              description: 待处理音频文件（通常是人声或旋律）的 URL。
              example: https://cdn.vidgo.ai/temp/vocals.mp3
            title:
              type: string
              description: |-
                生成音乐的名称。

                最多 100 个字符。
              maxLength: 100
              example: Relaxing Piano
            tags:
              type: string
              description: |-
                伴奏期望的音乐风格。

                可指定要包含的流派、情绪或乐器。
              example: relaxing, piano, soothing
            negative_tags:
              type: string
              description: |-
                生成时要排除的音乐风格或特征。

                指定输出中要避免的曲风、情绪或乐器。
              example: heavy metal, fast drums
            mv:
              type: string
              description: |-
                用于伴奏生成的 AI 模型版本。

                - **V5**：音乐表现力更出色，生成更快
                - **V4_5PLUS**：音色更丰富，创作方式更新

                默认：V4_5PLUS
              enum:
                - V4_5PLUS
                - V5
              example: V4_5PLUS
            vocal_gender:
              type: string
              description: |-
                生成人声时的首选人声性别。

                - `m`：男声
                - `f`：女声

                **注意**：此参数只能提高指定性别出现的概率，无法保证。
              enum:
                - m
                - f
              example: m
            style_weight:
              type: number
              description: |-
                控制指定风格对生成结果的影响强度。

                取值范围：0-1，最多 2 位小数。

                值越高，越贴合指定风格。
              minimum: 0
              maximum: 1
              example: 0.65
            weirdness_constraint:
              type: number
              description: |-
                控制实验性创意和非常规元素的程度。

                取值范围：0-1，最多 2 位小数。

                - 值较低：音乐更常规
                - 值较高：输出更具实验性和独特性
              minimum: 0
              maximum: 1
              example: 0.65
            audio_weight:
              type: number
              description: |-
                在音频特性与其他生成因素之间取得平衡。

                取值范围：0-1，最多 2 位小数。

                调整最终输出中对音质和声音特征的侧重。
              minimum: 0
              maximum: 1
              example: 0.65
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: HTTP 状态码
        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
              example: not_started
              description: 初始任务状态
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: 任务创建时间，ISO 8601 格式
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        所有 API 接口都需要 Bearer Token 认证


        获取 API Key：


        进入 **仪表盘 → API 密钥**（[API Key
        管理页面](https://vidgo.ai/apis/dashboard/api-key)）获取你的 API Key


        在请求头中添加：


        ```

        Authorization: Bearer VIDGO_API_KEY

        ```

````

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