Generate Persona
Create a personalized music Persona based on generated music, giving the music a unique identity and characteristics.
Usage Guide
- Use this endpoint to create Personas (music characters) for generated music
- Requires the taskId from supported music generation endpoints (generate, extend, mashup) and audio ID
- Customize the Persona name and description to give music unique personality
- Generated Personas can be used for subsequent music creation and style transfer
- Optionally specify vocalStart and vocalEnd to define the time range (10-30 seconds) for analysis. If not provided, defaults to 0.0 and 30.0 respectively
Parameter Details
taskId: Required parameter, can be obtained from the following endpoints:- Generate Music (
/api/v1/generate) - Extend Music (
/api/v1/generate/extend)
- Generate Music (
audioId: Required parameter, specifies the audio ID to create Persona forname: Required parameter, assigns an easily recognizable name to the Personadescription: Required parameter, describes the Persona’s musical characteristics, style, and personalityvocalStart: Optional parameter, start time (in seconds) of the audio segment to analyze. Default value is 0.0. Must be between 0 and the audio duration, and the segment length (vocalEnd - vocalStart) must be between 10-30 seconds.vocalEnd: Optional parameter, end time (in seconds) of the audio segment to analyze. Default value is 30.0. Must be between 0 and the audio duration, and the segment length (vocalEnd - vocalStart) must be between 10-30 seconds.style: Optional parameter, music style label to help categorize the Persona
Developer Notes
- Important: Ensure the music generation task is fully completed before calling this endpoint. If the music is still generating, this endpoint will return a failure
- Model Requirement: Persona generation supports taskId from music generated with models V4 and above
- It is recommended to provide detailed descriptions for Personas to better capture musical characteristics
- The returned
personaIdcan be used in subsequent music generation requests to create music with similar style characteristics - You can apply the
personaIdto the following endpoints: - Each audio ID can only generate a Persona once
Parameter Example
Authorizations
🔑 API Authentication
All endpoints require authentication using Bearer Token.
Get API Key
- Visit the API Key Management Page to obtain your API Key
Usage
Add to request headers:
Authorization: Bearer YOUR_API_KEY⚠️ Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately from the management page
Body
Unique identifier of the original music generation task. This can be a taskId returned from any of the following endpoints:
- Generate Music (/api/v1/generate)
- Extend Music (/api/v1/generate/extend)
"5c79****be8e"
Audio ID of the music track to create Persona for.
"e231****-****-****-****-****8cadc7dc"
Name for the Persona. A descriptive name that captures the essence of the musical style or character.
"Electronic Pop Singer"
Detailed description of the Persona's musical characteristics, style, and personality. Be specific about genre, mood, instrumentation, and vocal qualities.
"A modern electronic music style pop singer, skilled in dynamic rhythms and synthesizer tones"
Start time (in seconds) of the audio segment to analyze for Persona generation. Optional. Default value is 0.0. Must be between 0 and the audio duration. The segment length (vocalEnd - vocalStart) must be between 10-30 seconds.
x >= 00
End time (in seconds) of the audio segment to analyze for Persona generation. Optional. Default value is 30.0. Must be between 0 and the audio duration. The segment length (vocalEnd - vocalStart) must be between 10-30 seconds.
x >= 030
Music style label to help categorize the Persona. Optional.
"Electronic Pop"
Response
Request successful
Response Status Codes
- 200: Success - Request has been processed successfully
- 401: Unauthorized - Authentication credentials are missing or invalid
- 402: Insufficient Credits - Account does not have enough credits to perform the operation
- 404: Not Found - The requested resource or endpoint does not exist
- 409: Conflict - Persona already exists for this music
- 422: Validation Error - The request parameters failed validation checks
- 429: Rate Limited - Request limit has been exceeded for this resource
- 451: Unauthorized - Failed to fetch the music data. Kindly verify any access limits set by you or your service provider
- 455: Service Unavailable - System is currently undergoing maintenance
- 500: Server Error - An unexpected error occurred while processing the request
200, 401, 402, 404, 409, 422, 429, 451, 455, 500 Error message when code != 200
"success"
