Get API Key Get API
Docs

Generate mashup (mashup)

- Remix a song into a new creation.

  • Referencing source tracks: requires exactly 2, specified via task_ids (an array of length 2) + optional audio_indexes
  • Async task: submitting returns a task_id; poll GET /v1/music/tasks/:task_id for the result
Info

Referencing source tracks: mashup requires exactly 2 source tracks—specify them via task_ids (an array of exactly 2 of ythe task_ids), with optional audio_indexes (a parallel array selecting which item in each task's music[], 1-based, default 1 for both).

Warning

custom determines which fields take effect. All submitted fields must still meet their type, range, and length requirements, even when they do not take effect in the current mode. With custom=true, prompt (lyrics), title, tags, negative_tags, auto_lyrics, style_weight, weirdness, audio_weight, and persona_id take effect, while gpt_description is ignored. With custom=false, only gpt_description is used; it is required, and omitting it returns 400 during submission. vocal_gender takes effect in both modes. If custom is omitted, the backend infers it in this order: prompt present → true; no prompt but gpt_description present → false; otherwise, tags or title present → true.

Request example

curl -X POST https://api.openveer.com/v1/music/generations/mashup \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "suno",
    "task_ids": ["task_01ABC", "task_01DEF"],
    "audio_indexes": [1, 2],
    "custom": true,
    "prompt": "upbeat mashup of the two tracks"
  }'

Response example

{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01K8SGYNNNVBQTXNR4MM964S7K"
    }
  ]
}

Authorizations

Authorization string

All endpoints require authentication using a Bearer Token

Get an API Key:

Visit the API Key management page to get your API Key

Add the following to the request headers when using it:

Authorization: Bearer YOUR_API_KEY

Body

model string

Audio model. Currently pass suno (defaults to suno if omitted).

task_ids string[]

Array of ythe task_ids for the 2 source tracks (must be exactly 2; any other count returns 400 directly at submission time).

audio_indexes integer[]

An array parallel to task_ids that selects a track from each task's data.result.music[] array (1-based; each entry defaults to 1).

instrumental boolean

Whether purely instrumental (true=no vocals). If omitted, defaults to false (with vocals).

version string

Public version: v6 / v6-wild / v6-mini. Defaults to v6; omit this field when using custom_model_id.

custom_model_id string

The full UUID returned by the model-creation task. Mutually exclusive with version and persona_id.

custom boolean

true=custom mode (prompt used as lyrics); false=inspiration mode (uses gpt_description); if omitted, inferred from the content (see the Warning above).

prompt string

Conditionally required: provide lyrics when custom=true && instrumental=false. The field is inactive in inspiration mode, but any submitted value must still meet the length limit.

gpt_description string

Inspiration prompt. Required when custom=false — if missing, the request fails with 400 at submission (nothing is charged).

title string

Title. Only takes effect when custom=true.

tags string

Style tags. Only takes effect when custom=true.

negative_tags string

Style tags to exclude. Only takes effect when custom=true.

auto_lyrics boolean

true=rewrite the provided lyrics creatively. Only takes effect when custom=true.

style_weight number

Style weight, 0.00–1.00 (out-of-range values return 400 directly at submission time). Only takes effect when custom=true.

weirdness number

Creativity weight, from 0.00 to 1.00. weirdness_constraint is accepted as a legacy alias; use weirdness for new requests.

audio_weight number

Audio weight, 0.00–1.00. Only takes effect when custom=true.

vocal_gender string

Vocal gender: Male / Female. Works in both modes.

persona_id string

Persona Style ID. Only applies when custom=true is used and mutually exclusive with custom_model_id.

variety string

Style variation: off / normal / high / extra / max. Optional.

max_mode boolean

Enables Max mode. Requires custom mode and is billed at twice the standard price.

audio_format string

Output audio format: mp3 / m4a / wav. This endpoint does not support a target-duration field.

Note

Get Result: This is an asynchronous task. After submission, you will receive task_id and then poll GET /v1/music/tasks/{task_id} every 3–5 seconds until status becomes completed or failed (music generation usually takes 30–120 seconds; while generation is in progress, status may be pending or processing, and progress is an integer from 0 to 100 and is not guaranteed to change at fixed intervals). Once completed, read audio_url from data.result.music[]. In case of failure, data.error.message provides the reason and the deducted amount will be automatically refunded.

Response

code integer

Response status code

data array
Returned data array
status string

Task status

  * submitted - Submitted
task_id string

Unique task identifier (used to poll GET /v1/music/tasks/{task_id} for the result)

This documentation is built and hosted on Mintlify, a developer documentation platform.