Generate Persona

curl --request POST \
  --url https://api.vidgo.ai/api/generate/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "generate-persona",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "task_id": "5c79xxxxbe8e",
    "audio_id": "e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc",
    "name": "Smooth Jazz Singer",
    "description": "A sultry jazz vocalist with smooth, mellow tones. Specializes in late-night jazz ballads with piano accompaniment and warm, intimate delivery."
  }
}
'

{
  "code": 200,
  "data": {
    "task_id": "task-unified-1757165031-uyujaw3d",
    "status": "not_started",
    "created_time": "2025-11-12T10:30:00"
  }
}

{
  "code": 409,
  "error": {
    "message": "Persona already exists for this audio",
    "type": "conflict_error"
  }
}

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-persona",
  "callback_url": "https://your-domain.com/callback",
  "input": {
    "task_id": "5c79xxxxbe8e",
    "audio_id": "e231xxxx-xxxx-xxxx-xxxx-xxxx8cadc7dc",
    "name": "Smooth Jazz Singer",
    "description": "A sultry jazz vocalist with smooth, mellow tones. Specializes in late-night jazz ballads with piano accompaniment and warm, intimate delivery."
  }
}
'

{
  "code": 200,
  "data": {
    "task_id": "task-unified-1757165031-uyujaw3d",
    "status": "not_started",
    "created_time": "2025-11-12T10:30:00"
  }
}

{
  "code": 409,
  "error": {
    "message": "Persona already exists for this audio",
    "type": "conflict_error"
  }
}

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.
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 a reusable musical persona from an existing audio track
Personas capture the vocal style, genre characteristics, and musical personality
Once created, personas can be used with the Generate Music endpoint via the persona_id parameter

Parameter Details

task_id (required): Task ID from a completed music generation (Generate, Extend, Upload Cover, or Upload Extend)
audio_id (required): Specific audio track identifier from the callback data
name (required): A descriptive name that captures the musical style or character
description (required): Detailed description including:
- Genre and mood
- Instrumentation preferences
- Vocal characteristics
- Unique musical personality traits

Developer Notes

Each audio track can only have one persona created from it
If a persona already exists for the audio, the API returns error code 409
You can apply the persona_id to the following endpoints:
Provide detailed descriptions for best results when using the 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-persona for this endpoint.

Available options:

generate-persona

Example:

"generate-persona"

input

object

required

Input parameters for persona generation

Show child attributes

callback_url

string<uri>

Webhook callback URL for result notifications

Example:

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

Response

Task submitted successfully

code

integer

required

HTTP status code

Example:

200

data

object

required

Show child attributes

Replace Section Generate Lyrics

Overview

Image Series

Video Series

Music Series

File Management

Task Management

Account Management

Usage Guide

Parameter Details

Developer Notes

Authorizations

Body

Response

​Usage Guide

​Parameter Details

​Developer Notes

Authorizations

Body

Response

Usage Guide

Parameter Details

Developer Notes