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": "generate-music",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "prompt": "A calm and relaxing piano track with soft melodies",
    "style": "Classical",
    "title": "Peaceful Piano Meditation",
    "custom_mode": true,
    "instrumental": true,
    "mv": "V5",
    "negative_tags": "Heavy Metal, Upbeat Drums",
    "style_weight": 0.65
  }
}
'
{
  "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 creates music based on your text prompt
  • Multiple variations will be generated for each request
  • You can control detail level with custom mode and instrumental settings

​
Parameter Details

  • In Custom Mode ( custom_mode: true ):
    • If instrumental: true : style and title are required
    • If instrumental: false : style, prompt, and title are required
    • Character limits vary by model:
      • V4: prompt 3000 characters, style 200 characters
      • V4_5 & V4_5PLUS: prompt 5000 characters, style 1000 characters
      • V4_5ALL: prompt 5000 characters, style 1000 characters
      • V5: prompt 5000 characters, style 1000 characters
    • title length limit: 80 characters (all models)
  • In Non-custom Mode ( custom_mode: false ):
    • prompt length limit: 500 characters
    • Other parameters should be left empty

​
Developer Notes

  • Recommendation for new users: Start with custom_mode: false for simpler usage

​
Optional parameters

  • vocal_gender (string): Vocal gender preference. Use m for male, f for female. Note: This parameter is only effective when custom_mode is true . Based on practice, this parameter can only increase the probability but cannot guarantee adherence to male/female voice instructions.
  • style_weight (number): Strength of adherence to style. Range 0-1, up to 2 decimals. Example: 0.65 .
  • weirdness_constraint (number): Controls creative deviation. Range 0-1, up to 2 decimals. Example: 0.65 .
  • audio_weight (number): Balance weight for audio features. Range 0-1, up to 2 decimals. Example: 0.65 .
  • persona_id (string): Persona ID to apply to the generated music. Use this to apply a specific persona style to your music generation. Only available when Custom Mode is enabled. How to generate persona_id, visit generate-persona.

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 generate-music for this endpoint.

Available options:
generate-music
Example:

"generate-music"

​
input
object
required

Input parameters for music generation

​
callback_url
string<uri>

Webhook callback URL for result notifications

Example:

"https://your-domain.com/callback"

Response

200 - application/json

Task submitted successfully

​
code
integer
required

HTTP status code

Example:

200

​
data
object
required