Application Process
To use the API, you need to first apply for the corresponding service on the Producer Audios Generation API page. After entering the page, click the “Acquire” button, as shown in the image:
If you are not logged in or registered, you will be automatically redirected to the login page inviting you to register and log in. After logging in or registering, you will be automatically returned to the current page.
There will be a free quota offered for first-time applicants, allowing you to use the API for free.
Basic Usage
You can input any text to generate songs. For example, if I want to generate a song about Christmas, I can inputa song for Christmas, as shown in the image:
accept: the format of the response you want to receive, filled in asapplication/json, which means JSON format.authorization: the key to call the API, which can be selected directly after application.
action: the action for this music generation task, which isgeneratefor generating a song.model: the model used to create the song, currently mainly including: FUZZ-2.0 Pro, FUZZ-2.0, FUZZ-2.0 Raw, FUZZ-1.1 Pro, FUZZ-1.0 Pro, FUZZ-1.0, FUZZ-1.1, FUZZ-0.8.lyric: the content of the song lyrics.custom: whether to generate the song in a custom way.prompt: the prompt words in inspiration mode.title: the title information of the song.audio_id: the reference song ID for continuation/revision operations.continue_at: to continue writing the song from a specified second.replace_section_start/replace_section_end: the start and end time for replacing sections, in seconds.lyrics_strength: the strength of the lyrics, indicating the degree of influence of the lyrics in audio generation, optional between 0-1, default is 0.7.sound_strength: the strength of the audio prompt, optional between 0.2-1, default is 0.7.cover_strength: the cover strength between 0.2-1, default is 1.weirdness: the style peculiarity, optional between 0-1, default is 0.5.callback_url: the URL to receive callback results.instrumental: whether it is a no-lyric mode.
success, the status of the music generation task at this time.data, the result of this music taskid, the ID of the music generation task at this time.sound, the prompt words for the music generation task at this time.seed, the seed value for the music generation task at this time.audio_url, the audio link for the music generation task at this time.image_url, the cover link for the music generation task at this time.image_id, the cover ID for the music generation task at this time.state, the status of the music generation task at this time.duration, the duration information of the music at this time.progress, the progress value of the music task at this time.model, the model information used for the music generation task at this time.lyric, the lyrics information for the music generation task at this time.
data result.
Additionally, if you want to generate the corresponding integration code, you can directly copy the generated code, for example, the CURL code is as follows:
Custom Generation
If you want to customize the lyrics, you can input the lyrics: At this time, thelyric field can accept content similar to the following:
- lyric: the lyrics text
- custom: set to
true, indicating custom generation; this parameter defaults to false, indicating the use ofpromptfor generation. - title: the title of the song. Fill in the example as follows:
Cover Songs
If you want to perform a cover operation on an already generated song, you can input the song generated above for the cover, and next we will customize the song generation based on the lyrics and title. If you want to continue covering a song you uploaded, you can set the parameteraction to upload_cover and input the ID of the song you need to continue covering. The song ID can be obtained using the Producer Upload API, as shown in the image below:
- action: The action for this song task, currently supports: generate, cover, extend, upload_cover, upload_extend, replace_section, swap_vocals, swap_instrumentals, variation, this cover uses the
coverparameter. - lyric: Lyric text
- title: The title of the song.
- custom: Whether to use custom mode for generation, default is false.
- audio_id: The ID of the song to be covered.
Continue Writing the Song
If you want to continue writing the song, we need to pass theaction parameter value as: extend, and then we need to customize the song generation based on the lyrics, title, and style.
If you want to continue writing a song that you uploaded, you can set the action parameter to upload_extend and input the ID of the song you want to continue writing. The song ID can be obtained using the Producer Upload API, as shown in the image below:
Music Variation
If you want to generate a new piece of music with a similar effect based on the seed value of the previous music, we need to pass theaction parameter value as: variation, and then we can customize the generation of a new piece of music with a similar effect.
The sample input is as follows:
Replace Section
If you want to replace a section of the song, we need to pass theaction parameter value as: replace_section, and then we need to customize the song generation based on the lyrics and title.
If you want to continue replacing a section of a song you uploaded, you can set the action parameter to upload_replace_section and input the ID of the song you need to continue writing. The song ID can be obtained using the Producer Upload API, as shown in the image below:
Accompaniment Remix
If you want to use the official accompaniment remix operation, you can set theaction parameter value to: swap_instrumentals, then we will customize the song generation based on the lyrics and title.
The example to fill in is as follows:
Vocal Remix
If you want to use the official vocal remix operation, you can set theaction parameter value to: swap_vocals, then we will customize the song generation based on the lyrics, title, and style.
The example to fill in is as follows:
Lyrics and Music Separation
If you want to use the official lyrics and music separation operation, you can set theaction parameter value to: stems, and then we need to perform lyrics and music separation based on the song ID.
The sample input is as follows:
Asynchronous Callback
Since the Producer Audios Generation API can take a relatively long time to generate, if the API does not respond for a long time, the HTTP request will keep the connection open, leading to additional system resource consumption. Therefore, this API also provides support for asynchronous callbacks. The overall process is: when the client initiates a request, an additionalcallback_url field is specified. After the client initiates the API request, the API will immediately return a result containing a task_id field information, representing the current task ID. When the task is completed, the result of the generated task will be sent to the client-specified callback_url in the form of a POST JSON, which also includes the task_id field, allowing the task result to be associated by ID.
Let’s understand how to operate specifically through an example.
First, the Webhook callback is a service that can receive HTTP requests, and developers should replace it with the URL of their own HTTP server. For demonstration purposes, we use a public Webhook sample site https://webhook.site/. Opening this site will give you a Webhook URL, as shown in the image:
Copy this URL, and it can be used as a Webhook. The sample here is https://webhook.site/#!/view/0d73431d-f833-4be4-9276-b6e1690d55c1.
Next, we can set the callback_url field to the above Webhook URL, while filling in the corresponding parameters, as shown in the image:
The content is as follows:
task_id field, and other fields are similar to the above text. This field can be used to associate tasks.
Error Handling
When calling the API, if an error occurs, the API will return the corresponding error code and message. For example:400 token_mismatched: Bad request, possibly due to missing or invalid parameters.400 api_not_implemented: Bad request, possibly due to missing or invalid parameters.401 invalid_token: Unauthorized, invalid or missing authorization token.429 too_many_requests: Too many requests, you have exceeded the rate limit.500 api_error: Internal server error, something went wrong on the server.