> ## 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.

# 生成歌词

> 根据主题和描述，使用 AI 生成歌词

> [!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)接口获取结果。

## 使用指南

* 此接口根据你的主题或描述生成歌词
* 每次请求可能生成多个歌词版本
* 可在自定义模式下将生成的歌词用于 Generate Music 接口

## 参数详情

* `prompt`（必填）：对期望歌词内容的描述
  * 具体说明主题、情绪、风格或故事元素
  * 最大长度：200 个单词
  * 可包含流派感觉、情感基调和叙事元素等细节


## OpenAPI

````yaml zh/api-manual/music-series/generate-lyrics.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Generate Lyrics API
  description: 基于主题和描述的 AI 歌词生成
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Lyrics
      summary: 提交生成歌词任务
      description: 根据主题或描述生成歌词
      operationId: submitGenerateLyricsTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              nostalgic-song:
                summary: 怀旧童年歌曲
                value:
                  model: generate-lyrics
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      A nostalgic song about childhood memories and growing up
                      in a small town
              love-song:
                summary: 浪漫情歌
                value:
                  model: generate-lyrics
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      A romantic ballad about finding love unexpectedly in the
                      city
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '413':
          description: 提示词超出长度限制
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 413
                error:
                  message: Prompt exceeds maximum length of 200 words
                  type: payload_too_large
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - callback_url
        - input
      properties:
        model:
          type: string
          example: generate-lyrics
        callback_url:
          type: string
          format: uri
          description: |-
            用于结果通知的 Webhook 回调 URL。

            生成完成后，该地址会收到 POST 请求，包含结果和各个变体。
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
          description: 歌词生成的输入参数
          properties:
            prompt:
              type: string
              description: |-
                期望歌词内容的描述。

                尽量具体说明主题、情绪、风格或故事元素。

                最多 200 个单词。
              maxLength: 1500
              example: >-
                A nostalgic song about childhood memories and growing up in a
                small town
    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 格式
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          description: HTTP 状态码
        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：


        进入 **仪表盘 → 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.