SFX Endpoint

Overview

The SFX endpoint allows you to generate sound effects (SFX) from text prompts. It takes user input in the form of a text prompt to conditionally generate audio effects.

Open in Playground 🚀

Sample Generation

Cat Meow

Ambiance

Thunder and Rain

Campfire

Rifles shooting

Birds

Crowd

Bicycle

Piano

Drum

Fireworks

---

Example 1

Prompt:

The sound of a bustling city street with footsteps, faint conversations, and vehicle sounds.

Generated Music:

---

Example 2

Prompt:

Typing on a mechanical keyboard in a small office.

Generated Music:

---

Request

--request POST 'https://modelslab.com/api/v6/voice/sfx' \

Watch the SFX API Demo video to see it in action Postman.

Make a POST request to https://modelslab.com/api/v6/voice/sfx endpoint and pass the required parameters as a request body.

Body Attributes

Parameter	Description	Values
key	The API key required to authorize the request.	String
prompt	A descriptive input that specifies the type of sound effect to generate.	String
duration	The length of the generated sound effect in seconds. Defaults to 10. Range: 3 to 15 seconds	Integral value
temp	Temporary links for regions blocking storage site access.	TRUE or FALSE

Example

Body

Body

{
    "key":"",
    "prompt":"Thunderstorm with rain",
    "temp": false,
    "webhook": null,
    "track_id": null
}

Request

JS

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
    "key":"",
    "prompt":"Thunderstorm with rain",
    "temp": false,
    "webhook": null,
    "track_id": null
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://modelslab.com/api/v6/voice/sfx", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

<?php

$payload = [
    "key" => "",
    "prompt" => "Thunderstorm with rain",
    "temp" => false,
    "webhook" => null,
    "track_id" => null 
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v6/voice/sfx',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NODE

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v6/voice/sfx',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
     "key":"",
    "prompt":"Thunderstorm with rain",
    "temp": false,
    "webhook": null,
    "track_id": null
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PYTHON

import requests
import json

url = "https://modelslab.com/api/v6/voice/sfx"

payload = json.dumps({
    "key":"",
    "prompt":"Thunderstorm with rain",
    "temp": False,
    "webhook": None,
    "track_id":None
})

headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"key\":\"\",\n    \"prompt\":\"Thunderstorm with rain\",\n      \"webhook\":\"\",\n    \"track_id\":\"\"\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v6/voice/sfx")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

Success

{
    "status": "success",
    "generationTime": 1.904285192489624,
    "id": 1248942,
    "output": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/generations/d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav"
    ],
    "meta": {
        "duration": 10,
        "filename": "d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav",
        "id": "1248942",
        "prompt": "Thunderstorm with rain",
        "temp": "no",
        "track_id": null,
        "webhook": null
    }
}

Processing

{
    "status": "processing",
    "tip": "Your audio is processing in background, you can get this image using fetch API",
    "eta": 35,
    "message": "Try to fetch request after seconds estimated",
    "fetch_result": "https://modelslab.com/api/v6/voice/fetch/1248942",
    "id": 1248942,
    "output": [],
    "future_links": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/generations/d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav"
    ],
    "audio_time": null,
    "meta": {
        "duration": 10,
        "filename": "d5fb5cd5-b9c3-4aef-b7db-a3a595c12db0.wav",
        "id": "1248942",
        "prompt": "Thunderstorm with rain",
        "temp": "no",
        "track_id": null,
        "webhook": null
    }
}

Error

{
    "status": "error",
    "message": "Error message"
}