Skip to main content
POST
/
api
/
generate
/
submit
curl --request POST \
  --url https://api.vidgo.ai/api/generate/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "create-music-video",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "task_id": "taskId_774b9aa0422f",
    "audio_id": "e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc"
  }
}
'
{
  "code": 200,
  "data": {
    "task_id": "task-unified-1757165031-uyujaw3d",
    "status": "not_started",
    "created_time": "2025-11-12T10:30:00"
  }
}
  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 endpoint.

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

Authorizations

​
Authorization
string
header
required

All API endpoints require Bearer Token authentication

Get your API Key:

Visit the API Key Management Page to get your API Key

Add it to the request header:

Authorization: Bearer VIDGO_API_KEY

Body

application/json
​
model
enum<string>
required

API model identifier.

Must be create-music-video for this endpoint.

Available options:
create-music-video
Example:

"create-music-video"

​
callback_url
string<uri>
required

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
object
required

Input parameters for music video creation

Response

Task submitted successfully

​
code
integer
required

HTTP status code

Example:

200

​
data
object
required