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-lyrics",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "prompt": "A nostalgic song about childhood memories and growing up in a small town"
  }
}
'
{
  "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 song lyrics based on your theme or description
  • Multiple lyric variations may be generated for each request
  • Use the generated lyrics with the Generate Music endpoint in Custom Mode

​
Parameter Details

  • prompt (required): Description of the desired lyrics content
    • Be specific about theme, mood, style, or story elements
    • Maximum length: 200 words
    • Include details like genre feel, emotional tone, and narrative elements

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

Available options:
generate-lyrics
Example:

"generate-lyrics"

​
callback_url
string<uri>
required

Webhook callback URL for result notifications.

The endpoint will receive POST requests when generation completes, including results and variations.

Example:

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

​
input
object
required

Input parameters for lyrics generation

Response

Task submitted successfully

​
code
integer
required

HTTP status code

Example:

200

​
data
object
required