Sign in

v1

latestOpenAPI 3.1.02026-07-2611077199.5 KB

post/suno/v1/mashup

Request body

customboolean required

Whether to use custom mode.

  • true: Audio will be generated from lyrics
  • false: Audio will be generated based on inspiration mode prompts
instrumentalboolean required

Whether to generate instrumental music.

  • true: Generate instrumental-only music
  • false: Generate a track with vocals and lyrics
    • In inspiration mode, the gpt_description_prompt parameter is required
    • In custom mode, the prompt parameter is required
mv'chirp-v5-5' | 'chirp-v5' | 'chirp-v4-5+' | 'chirp-v4-5' | 'chirp-v4-5-all' | 'chirp-v4' | 'chirp-v3-5' | 'chirp-v3-0' required

Model to use.

gpt_description_promptstring

Prompt for inspiration mode.

When not using custom mode (custom=false), this parameter is always required. Lyrics will be automatically generated from this prompt. Maximum length: 3000 characters.

promptstring

Lyrics.

Used in custom mode (custom=true). Required when instrumental is false. The lyrics will be used and sung in the generated track. Maximum length: 5000 characters.

titlestring

Music title.

Used in custom mode (custom=true). Maximum length: 80 characters.

tagsstring

Music style or genre.

Used in custom mode (custom=true). Maximum length: 1000 characters.

negative_tagsstring

Music styles or genres that should be excluded from generation.

Used in custom mode (custom=true).

style_weightnumber

Music style weight, range: 0.00–1.00.

Used in custom mode. Valid range: 0 <= x <= 1.

weirdness_constraintnumber

Audio creativity (weirdness) weight, range: 0.00–1.00.

Used in custom mode. Valid range: 0 <= x <= 1.

audio_weightnumber

Audio weight, range: 0.00–1.00.

Used in custom mode. Valid range: 0 <= x <= 1.

auto_lyricsboolean

Whether to automatically generate lyrics. Custom mode only.

  • true: The input lyrics will be creatively rewritten, similar to the inspiration mode prompt effect
  • false: Use the provided lyrics directly to generate the music
vocal_gender'Male' | 'Female'

Vocal gender.

  • Male: Male voice

  • Female: Female voice

persona_idstring

Music style ID. Custom mode only.

Use this parameter to generate music with a specific style.

isStorageboolean

Whether to store the generated audio.

  • true: The audio will be stored and a TTAPI CDN URL will be returned
  • false: The original source URL will be returned
hookUrlstring

Callback notification URL

Example request

{
  "gpt_description_prompt": "Night city lo-fi piano with rain ambience, soft vocal phrases, theme: \"Under the city lights\"",
  "tags": "rock, blues, hip-hop, r&b",
  "style_weight": 0.5,
  "weirdness_constraint": 0.5,
  "audio_weight": 0.5,
  "mashup_music_id": [
    "xxx1",
    "xxx2"
  ]
}

Response

Request successful

statusstring required
messagestring required
dataobject required

Example response

{
  "status": "SUCCESS",
  "message": "success",
  "data": {
    "jobId": "jobId"
  }
}