MusicAPI
HomeDocs
HomeDocs
  1. sonic
  • Introduction
  • Credits Usage Guide
  • Music API FAQ & Troubleshooting
  • Common Scenarios
  • Error handling
  • sonic
    • Sonic Instructions
    • create music
      POST
    • extend music
      POST
    • concat music
      POST
    • cover music
      POST
    • create persona
      POST
    • create music with persona
      POST
    • upload music
      POST
    • get music
      GET
  • studio
    • Studio Instructions
    • description mode (Use case1)
      POST
    • extend mode (Use case2)
      POST
    • custom mode (Use case3)
      POST
    • instrumental mode (Use case4)
      POST
    • get music
      GET
  • lyrics generation
    • Make Lyrics
      POST
  • nuro
    • Nuro Instruction
    • Error handling
    • create music
      POST
    • get music
      GET
  1. sonic

Sonic Instructions

Key Field Usage#

1. Custom Mode: custom_mode = true#

In this mode, you can customize the song's title, style, and lyrics, corresponding to the fields:
title
tags
prompt

2. Non-Custom Mode: custom_mode = false#

In this mode, you only need the gpt_description_prompt field to describe the music.

3. Instrumental Control#

Use the make_instrumental field to control whether to generate instrumental-only music.

Field Details#

custom_mode:
A boolean switch for enabling custom mode.
Required
When enabled, it allows you to control the song's title, style, and lyrics.
prompt:
The song's lyrics.
Required if custom mode is enabled.
Should generally not exceed 3000 characters.
title:
The song's title.
Optional
Should generally not exceed 120 characters.
tags:
The song's style or genre.
Optional
Should generally not exceed 80 characters.
mv:
The model version for generation.
Required
Can be either sonic-v3-5 or sonic-v4.
make_instrumental:
Controls whether to generate instrumental-only music.
Optional
gpt_description_prompt:
A description of the song.
Required if custom mode is disabled.
Should generally not exceed 200 characters.
task_type:
Specifies the type of task to perform.
Required
Allowed values: create_music, extend_music, concat_music, cover_music,cover_upload_music, extend_upload_music, persona_music.
persona_id:
The ID of a persona created via the "create persona" API.
Optional
This ID can be used to generate music based on the specified persona.

Note#

When extending your own uploaded music, you need to use the extend_upload_music task type.
Modified at 2025-01-14 04:11:26
Previous
Error handling
Next
create music
Built with