Skip to main content
GET
/
api
/
generate
/
detail
/
music
Query Music Generation Detail
curl --request GET \
  --url https://api.vidgo.ai/api/generate/detail/music \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "data": {
    "task_id": "8FDN1I7M7Q68DDG8",
    "status": "finished",
    "files": [
      {
        "audio_id": "62e4542a-73be-44e1-b397-7716ee7505c6",
        "audio_url": "https://storage.vidgo.ai/audio/8FDN1I7M7Q68DDG8/20251125113627_QIivN2_tmphb8rgpeb_audio_62e4542a-73be-44e1-b397-7716ee7505c6.mp3",
        "image_url": "https://storage.vidgo.ai/audio/8FDN1I7M7Q68DDG8/20251125113628_4DfWp6_tmpz72j05o5_cover_62e4542a-73be-44e1-b397-7716ee7505c6.jpeg",
        "title": "Peaceful Piano Meditation",
        "tags": "Classical",
        "duration": 240,
        "prompt": ""
      },
      {
        "audio_id": "8e755734-a840-4c13-beac-b9f1044979ca",
        "audio_url": "https://storage.vidgo.ai/audio/8FDN1I7M7Q68DDG8/20251125113630_x7VTpV_tmpvsijwxa6_audio_8e755734-a840-4c13-beac-b9f1044979ca.mp3",
        "image_url": "https://storage.vidgo.ai/audio/8FDN1I7M7Q68DDG8/20251125113631_3MTe5V_tmp98wzcx2m_cover_8e755734-a840-4c13-beac-b9f1044979ca.jpeg",
        "title": "Peaceful Piano Meditation",
        "tags": "Classical",
        "duration": 130,
        "prompt": ""
      }
    ],
    "created_time": "2025-11-25T08:50:13",
    "error_message": null
  }
}

​
Usage Guide

  • All POST submission requests in the Music Series can query their results through this endpoint. Different models will return different response fields.

​
Parameter Details

  • task_id (required): The unique task identifier returned from the music generation submission endpoint

​
Developer Notes

  • Poll this endpoint to check task completion status
  • The files array will be empty until the task status is finished
  • When a task fails, check the error_message field for details
  • Multiple audio files may be returned for a single task as variations are generated

​
Response Fields (files data)

The files array content varies depending on which model created the task.
ModelFieldTypeDescription
generate-music, extend-music, upload-and-cover-audio, upload-and-extend-audio, add-instrumental, add-vocals, replace-sectionaudio_idstringUnique identifier for the audio file
↑audio_urlstringDirect download URL for the audio file
↑image_urlstringCover image URL
↑titlestringTrack title
↑tagsstringStyle tags
↑durationnumberAudio duration in seconds
↑promptstringGeneration prompt used
get-timestamped-lyricstimestampe_lyricsstringLyrics with timestamps
generate-lyricstitlestringLyrics title
↑textstringComplete lyrics content
boost-music-stylestylestringEnhanced music style
convert-to-wavwav_urlstringURL to converted WAV file
separate-vocalsseparate_vocalsstring (JSON)JSON string containing separated audio URLs. See details
upload-and-separate-vocalsvocal_removalstring (JSON)JSON string containing separated stem URLs. See details
stem-splitstem_splitstring (JSON)JSON string containing full stem separation URLs. See details
generate-music-covergenerate_coverstring (JSON)JSON string containing generated cover images. See details
generate-personapersona_idstringGenerated persona identifier
create-music-videovideo_urlstringGenerated video URL

​
JSON Field Details

​
separate-vocals

separate_vocals fields:
  • vocal_url - URL to the extracted vocal track
  • instrumental_url - URL to the instrumental track

​
upload-and-separate-vocals

vocal_removal fields:
  • bass - URL to the bass track
  • drums - URL to the drums track
  • piano - URL to the piano track
  • guitar - URL to the guitar track
  • vocals - URL to the vocals track
  • other - URL to other audio elements

​
stem-split

stem_split fields:
  • backing_vocals_url - URL to backing vocals
  • bass_url - URL to bass track
  • brass_url - URL to brass instruments
  • drums_url - URL to drums track
  • fx_url - URL to sound effects
  • guitar_url - URL to guitar track
  • keyboard_url - URL to keyboard track
  • percussion_url - URL to percussion track
  • strings_url - URL to strings track
  • synth_url - URL to synthesizer track
  • vocal_url - URL to main vocals
  • woodwinds_url - URL to woodwinds track

​
generate-music-cover

generate_cover is a JSON array containing cover image objects:
  • file_url - URL to the generated cover image
  • file_type - File type (e.g., “image”)

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

Query Parameters

​
task_id
string
required

Unique task identifier returned from the music generation submission endpoint.

Response

200 - application/json

Task detail retrieved successfully

​
code
integer
required

HTTP status code

Example:

200

​
data
object
required