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": "add-vocals",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "upload_url": "https://storage.example.com/instrumental.mp3",
    "prompt": "A heartfelt ballad about love and memories",
    "title": "Memories of You",
    "style": "Pop Ballad",
    "negative_tags": "rap, heavy metal"
  }
}
'
{
  "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 adds AI-generated vocals to an existing instrumental track
  • Upload an instrumental file and provide lyrics or a description for the vocals
  • Perfect for transforming instrumental tracks into complete songs

​
Parameter Details

  • Required parameters:
    • upload_url: URL of the instrumental audio file
    • prompt: Lyrics or description for the vocals
    • title: Name for the generated track
    • style: Music style to guide vocal delivery
    • negative_tags: Styles to exclude from generation
  • Model selection:
    • V5: Superior musical expressiveness with faster generation
    • V4_5PLUS: Enhanced tonal richness (default)

​
Developer Notes

  • The prompt parameter serves as both lyrics and creative direction for the vocals
  • Use style to specify the vocal delivery style (e.g., “Pop Ballad”, “Rock”, “R&B”)
  • Combine with vocal_gender for more control over the vocal output

​
Optional parameters

  • model (string): AI model version. Options: V4_5PLUS (default), V5.
  • vocal_gender (string): Vocal gender preference. Use m for male, f for female. Note: This parameter can only increase the probability but cannot guarantee the specified gender.
  • style_weight (number): Strength of adherence to style. Range 0-1, up to 2 decimals.
  • weirdness_constraint (number): Controls creative deviation. Range 0-1, up to 2 decimals.
  • audio_weight (number): Balance weight for audio features. Range 0-1, up to 2 decimals.

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 add-vocals for this endpoint.

Available options:
add-vocals
Example:

"add-vocals"

​
input
object
required

Input parameters for vocal 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