mashup

Mix two existing songs together to create a new song. This endpoint combines elements from two source clips to generate a unique mashup.

Credits cost: 15

How to Use

Provide two clip IDs in the mashup_clip_ids array

Choose between custom lyrics mode (custom_mode: true) or AI description mode (custom_mode: false)

Select a music model version

Optionally customize style, vocals, and other parameters

Custom Mode vs AI Description Mode

Custom Mode (custom_mode: true):

You provide the exact lyrics via the prompt parameter

Full control over the lyrical content

Requires prompt field

AI Description Mode (custom_mode: false):

AI generates lyrics based on your description

Provide a description via gpt_description_prompt

AI creates appropriate lyrics matching your description

Requires gpt_description_prompt field

Model Compatibility

Both sonic-* and chirp-* naming formats are supported:

sonic-v3-5 / chirp-v3-5

sonic-v4 / chirp-v4

sonic-v4-5 / chirp-v4-5

sonic-v4-5-plus / chirp-v4-5-plus

sonic-v5 / chirp-v5

Polling Result

Use the task query endpoint with the returned task_id to poll for results. Recommended polling interval: 15-25 seconds.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/json

Examples

Mashup with custom lyricsMashup with AI-generated lyricsInstrumental mashup

{
    "mashup_clip_ids": [
        "abc123-def456",
        "xyz789-ghi012"
    ],
    "custom_mode": true,
    "mv": "chirp-v4-5-plus",
    "prompt": "[Verse 1]\nMixing beats together\nCreating something new\n\n[Chorus]\nThis is our mashup\nBlending old and new",
    "title": "Epic Mashup",
    "tags": "electronic, dance, energetic",
    "style_weight": 0.7
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

How to Use#

Custom Mode vs AI Description Mode#

Model Compatibility#