Sample to song (sample)

Reference the source track: specified by task_id + audio_index, no need to record any extra id
Async task: submitting returns a task_id; poll GET /v1/music/tasks/:task_id for the result

Info

Source Audio Reference: No additional IDs are needed for tracks based on existing songs. Just pass task_id (the task ID from the previous run of this task) + audio_index (which result track in the data.result.music[] list, 1-based, default is 1).

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, and audio_weight 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/sample \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "suno",
    "task_id": "task_01ABC",
    "audio_index": 1,
    "start_s": 0,
    "end_s": 8,
    "instrumental": false,
    "prompt": "along the night continue to sing",
    "version": "v6",
    "tags": "upbeat pop"
  }'

import requests

url = "https://api.openveer.com/v1/music/generations/sample"

payload = {
    "model": "suno",
    "task_id": "task_01ABC",
    "audio_index": 1,
    "start_s": 0,
    "end_s": 8,
    "instrumental": False,
    "prompt": "along the night continue to sing",
    "version": "v6",
    "tags": "upbeat pop"
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

const url = "https://api.openveer.com/v1/music/generations/sample";

const payload = {
  model: "suno",
  task_id: "task_01ABC",
  audio_index: 1,
  start_s: 0,
  end_s: 8,
  instrumental: false,
  prompt: "Sing on into the night",
  version: "v6",
  tags: "upbeat pop"
};

const headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
};

fetch(url, {
  method: "POST",
  headers: headers,
  body: JSON.stringify(payload)
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://api.openveer.com/v1/music/generations/sample"

    payload := map[string]interface{}{
        "model": "suno",
        "task_id": "task_01ABC",
        "audio_index": 1,
        "start_s": 0,
        "end_s": 8,
        "instrumental": false,
        "prompt": "sing along into the night",
        "version": "v6",
        "tags": "upbeat pop",
    }

    jsonData, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    req.Header.Set("Authorization", "Bearer <token>")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://api.openveer.com/v1/music/generations/sample";

        String payload = """
        {
          "model": "suno",
          "task_id": "task_01ABC",
          "audio_index": 1,
          "start_s": 0,
          "end_s": 8,
          "instrumental": false,
          "prompt": "sing along into the night",
          "version": "v6",
          "tags": "upbeat pop"
        }
        """;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

<?php

$url = "https://api.openveer.com/v1/music/generations/sample";

$payload = [
    "model" => "suno",
    "task_id" => "task_01ABC",
    "audio_index" => 1,
    "start_s" => 0,
    "end_s" => 8,
    "instrumental" => false,
    "prompt" => "sing along in the night",
    "version" => "v6",
    "tags" => "upbeat pop"
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

require 'net/http'
require 'json'
require 'uri'

url = URI("https://api.openveer.com/v1/music/generations/sample")

payload = {
  model: "suno",
  task_id: "task_01ABC",
  audio_index: 1,
  start_s: 0,
  end_s: 8,
  instrumental: false,
  prompt: "Sing on into the night",
  version: "v6",
  tags: "upbeat pop"
}

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = payload.to_json

response = http.request(request)
puts response.body

import Foundation

let url = URL(string: "https://api.openveer.com/v1/music/generations/sample")!

let payload: [String: Any] = [
    "model": "suno",
    "task_id": "task_01ABC",
    "audio_index": 1,
    "start_s": 0,
    "end_s": 8,
    "instrumental": false,
    "prompt": "along the night continue to sing",
    "version": "v6",
    "tags": "upbeat pop"
]

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let error = error {
        print("Error: \(error)")
        return
    }

    if let data = data, let responseString = String(data: data, encoding: .utf8) {
        print(responseString)
    }
}

task.resume()

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var url = "https://api.openveer.com/v1/music/generations/sample";

        var payload = @"{
            ""model"": ""suno"",
            ""task_id"": ""task_01ABC"",
            ""audio_index"": 1,
            ""start_s"": 0,
            ""end_s"": 8,
            ""instrumental"": false,
            ""prompt"": ""sing on into the night"",
            ""version"": ""v6"",
            ""tags"": ""upbeat pop""
        }";

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

        var content = new StringContent(payload, Encoding.UTF8, "application/json");
        var response = await client.PostAsync(url, content);
        var result = await response.Content.ReadAsStringAsync();

        Console.WriteLine(result);
    }
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl;
    CURLcode res;

    curl_global_init(CURL_GLOBAL_DEFAULT);
    curl = curl_easy_init();

    if(curl) {
        const char *url = "https://api.openveer.com/v1/music/generations/sample";
        const char *payload = "{"
            "\"model\":\"suno\","
            "\"task_id\":\"task_01ABC\","
            "\"audio_index\":1,"
            "\"start_s\":0,"
            "\"end_s\":8,"
            "\"instrumental\":false,"
            "\"prompt\":\"sing on into the night\","
            "\"version\":\"v6\","
            "\"tags\":\"upbeat pop\""
        "}";

        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer <token>");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, payload);
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

        res = curl_easy_perform(curl);

        if(res != CURLE_OK) {
            fprintf(stderr, "curl_easy_perform() failed: %s\n",
                    curl_easy_strerror(res));
        }

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }

    curl_global_cleanup();
    return 0;
}

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSURL *url = [NSURL URLWithString:@"https://api.openveer.com/v1/music/generations/sample"];

        NSDictionary *payload = @{
            @"model": @"suno",
            @"task_id": @"task_01ABC",
            @"audio_index": @1,
            @"start_s": @0,
            @"end_s": @8,
            @"instrumental": @NO,
            @"prompt": @"sing along into the night",
            @"version": @"v6",
            @"tags": @"upbeat pop"
        };

        NSError *error;
        NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payload
                                                          options:0
                                                            error:&error];

        NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
        [request setHTTPMethod:@"POST"];
        [request setValue:@"Bearer <token>" forHTTPHeaderField:@"Authorization"];
        [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
        [request setHTTPBody:jsonData];

        NSURLSessionDataTask *task = [[NSURLSession sharedSession]
            dataTaskWithRequest:request
            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                if (error) {
                    NSLog(@"Error: %@", error);
                    return;
                }
                NSString *result = [[NSString alloc] initWithData:data
                                                        encoding:NSUTF8StringEncoding];
                NSLog(@"%@", result);
            }];

        [task resume];
        [[NSRunLoop mainRunLoop] run];
    }
    return 0;
}

(* Requires cohttp and yojson libraries *)
open Lwt
open Cohttp
open Cohttp_lwt_unix

let url = "https://api.openveer.com/v1/music/generations/sample"

let payload = {|{
  "model": "suno",
  "task_id": "task_01ABC",
  "audio_index": 1,
  "start_s": 0,
  "end_s": 8,
  "instrumental": false,
  "prompt": "sing on into the night",
  "version": "v6",
  "tags": "upbeat pop"
}|}

let () =
  let headers = Header.init ()
    |> fun h -> Header.add h "Authorization" "Bearer <token>"
    |> fun h -> Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string payload in

  let response = Client.post ~headers ~body (Uri.of_string url) >>= fun (resp, body) ->
    body |> Cohttp_lwt.Body.to_string >|= fun body_str ->
    print_endline body_str
  in
  Lwt_main.run response

import 'dart:convert';
import 'package:http/http.dart' as http;

void main() async {
  final url = Uri.parse('https://api.openveer.com/v1/music/generations/sample');

  final payload = {
    'model': 'suno',
    'task_id': 'task_01ABC',
    'audio_index': 1,
    'start_s': 0,
    'end_s': 8,
    'instrumental': false,
    'prompt': 'sing on into the night',
    'version': 'v6',
    'tags': 'upbeat pop'
  };

  final response = await http.post(
    url,
    headers: {
      'Authorization': 'Bearer <token>',
      'Content-Type': 'application/json',
    },
    body: jsonEncode(payload),
  );

  print(response.body);
}

library(httr)
library(jsonlite)

url <- "https://api.openveer.com/v1/music/generations/sample"

payload <- list(
  model = "suno",
  task_id = "task_01ABC",
  audio_index = 1,
  start_s = 0,
  end_s = 8,
  instrumental = FALSE,
  prompt = "Sing on into the night",
  version = "v6",
  tags = "upbeat pop"
)

response <- POST(
  url,
  add_headers(
    Authorization = "Bearer <token>",
    `Content-Type` = "application/json"
  ),
  body = toJSON(payload, auto_unbox = TRUE),
  encode = "raw"
)

cat(content(response, "text"))

Response example

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

{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": 401,
    "message": "Authentication failed, please check your API key",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": 402,
    "message": "Insufficient account balance, please top up and try again",
    "type": "payment_required"
  }
}

{
  "error": {
    "code": 403,
    "message": "Access forbidden, you do not have permission to access this resource",
    "type": "permission_error"
  }
}

{
  "error": {
    "code": 429,
    "message": "Too many requests, please try again later",
    "type": "rate_limit_error"
  }
}

{
  "error": {
    "code": 500,
    "message": "Internal server error, please try again later",
    "type": "server_error"
  }
}

{
  "error": {
    "code": 502,
    "message": "Gateway error, the server is temporarily unavailable",
    "type": "bad_gateway"
  }
}

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_id string

The source task's task_id. It must identify an uploadTask upload task; a missing, non-upload, or invalid source returns 400 during submission.

audio_index integer

Selects a track from the source task's data.result.music[] array (1-based: 1 is the first track; default 1).

start_s number

Sampling start point (seconds). If missing, returns 400 immediately.

end_s number

Sample end time in seconds. It must satisfy 0 ≤ start_s < end_s and cannot exceed the known source duration.

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.

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.

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

The source task must be an uploadTask upload task. Both start_s and end_s are required; the service does not fill in defaults such as 0 or 60.

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.