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

# Create Music Video

> Generate visualized music videos from audio tracks

<Tip>
  1. After submission, a `task_id` will be returned. If you provided a `callback_url`, when the task status becomes `finished` or `failed`, a POST request will be sent to the `callback_url`.
  2. Regardless of whether `callback_url` is provided, you can retrieve the response result through the unified [Query Music Detail](/api-manual/music-series/query-music-detail) endpoint.
</Tip>

## Usage Guide

* This endpoint generates visualized music videos from audio tracks
* Creates MP4 videos with audio visualization and optional branding
* Useful for social media content, promotional materials, or music sharing

## Parameter Details

* `task_id` (required): Task ID from a completed music generation (Generate Music or Extend Music)
* `audio_id` (required): Specific audio track identifier from the callback data

## Developer Notes

* Each audio track can only have one music video generated
* If a video already exists, the API returns error code 409
* The callback includes a download URL for the generated MP4 video
* Video generation may take longer than audio processing tasks

## Optional parameters

* `author` (string): Artist or creator name displayed on the video cover. Maximum 50 characters.
* `domain_name` (string): Website or brand watermark displayed at the bottom of the video. Maximum 50 characters.


## OpenAPI

````yaml /api-manual/music-series/create-music-video.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Create Music Video API
  description: Generate visualized music videos from audio tracks
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Music Video
      summary: Submit Music Video Creation Task
      description: Generate a visualized music video from an audio track
      operationId: submitCreateMusicVideoTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              basic-video:
                summary: Basic Music Video
                value:
                  model: create-music-video
                  callback_url: https://your-domain.com/callback
                  input:
                    task_id: taskId_774b9aa0422f
                    audio_id: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
              branded-video:
                summary: Branded Music Video with Attribution
                value:
                  model: create-music-video
                  callback_url: https://your-domain.com/callback
                  input:
                    task_id: taskId_774b9aa0422f
                    audio_id: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
                    author: DJ Electronic
                    domain_name: music.example.com
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '409':
          description: Music video already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 409
                error:
                  message: Music video already exists for this audio
                  type: conflict_error
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - callback_url
        - input
      properties:
        model:
          type: string
          description: |-
            API model identifier.

            Must be `create-music-video` for this endpoint.
          enum:
            - create-music-video
          example: create-music-video
        callback_url:
          type: string
          format: uri
          description: >-
            Webhook callback URL for result notifications.


            The endpoint will receive POST requests with music video generation
            completion status and download URL.
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - task_id
            - audio_id
          description: Input parameters for music video creation
          properties:
            task_id:
              type: string
              description: >-
                Unique identifier of the music generation task.


                Should be a task_id returned from the Generate Music or Extend
                Music endpoints.
              example: taskId_774b9aa0422f
            audio_id:
              type: string
              description: >-
                Unique identifier of the specific audio track to visualize.


                This ID is returned in the callback data after music generation
                completes.
              example: e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc
            author:
              type: string
              description: |-
                Artist or creator name for video cover attribution.

                Maximum 50 characters.
              maxLength: 50
              example: DJ Electronic
            domain_name:
              type: string
              description: |-
                Website or brand watermark displayed at video bottom.

                Maximum 50 characters.
              maxLength: 50
              example: music.example.com
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: HTTP status code
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
              description: Unique task identifier for status tracking
            status:
              type: string
              enum:
                - not_started
              example: not_started
              description: Initial task status
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: ISO 8601 timestamp when the task was created
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          description: HTTP status code
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
              description: Error message describing what went wrong
            type:
              type: string
              example: invalid_request_error
              description: Error type identifier
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        All API endpoints require Bearer Token authentication


        Get your API Key:


        Visit the [API Key Management
        Page](https://vidgo.ai/apis/dashboard/api-key) to get your API Key


        Add it to the request header:


        ```

        Authorization: Bearer VIDGO_API_KEY

        ```

````