Audio Sound Effects

curl --request POST \
  --url https://kymaapi.com/v1/audio/sfx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "duration_seconds": 123,
  "prompt_influence": 123,
  "response_format": "<string>"
}
'

import requests

url = "https://kymaapi.com/v1/audio/sfx"

payload = {
    "model": "<string>",
    "prompt": "<string>",
    "duration_seconds": 123,
    "prompt_influence": 123,
    "response_format": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    prompt: '<string>',
    duration_seconds: 123,
    prompt_influence: 123,
    response_format: '<string>'
  })
};

fetch('https://kymaapi.com/v1/audio/sfx', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://kymaapi.com/v1/audio/sfx",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'prompt' => '<string>',
    'duration_seconds' => 123,
    'prompt_influence' => 123,
    'response_format' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://kymaapi.com/v1/audio/sfx"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://kymaapi.com/v1/audio/sfx")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kymaapi.com/v1/audio/sfx")

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 = "{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}"

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

POST

audio

sfx

Audio Sound Effects

curl --request POST \
  --url https://kymaapi.com/v1/audio/sfx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>",
  "duration_seconds": 123,
  "prompt_influence": 123,
  "response_format": "<string>"
}
'

import requests

url = "https://kymaapi.com/v1/audio/sfx"

payload = {
    "model": "<string>",
    "prompt": "<string>",
    "duration_seconds": 123,
    "prompt_influence": 123,
    "response_format": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    prompt: '<string>',
    duration_seconds: 123,
    prompt_influence: 123,
    response_format: '<string>'
  })
};

fetch('https://kymaapi.com/v1/audio/sfx', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://kymaapi.com/v1/audio/sfx",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'prompt' => '<string>',
    'duration_seconds' => 123,
    'prompt_influence' => 123,
    'response_format' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://kymaapi.com/v1/audio/sfx"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://kymaapi.com/v1/audio/sfx")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kymaapi.com/v1/audio/sfx")

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 = "{\n  \"model\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"duration_seconds\": 123,\n  \"prompt_influence\": 123,\n  \"response_format\": \"<string>\"\n}"

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

Synchronous endpoint. Describe a sound — door slam, rain, sword unsheathing, ambient room — get back a clip. Pairs naturally with /v1/audio/music for video and game soundtracking.

curl -X POST https://kymaapi.com/v1/audio/sfx \
  -H "Authorization: Bearer $KYMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "heavy wooden door slamming shut in stone hallway, with reverb",
    "duration_seconds": 3
  }' \
  --output door.mp3

Request

application/json body.

string

default:"elevenlabs-sfx"

SFX model. Currently only elevenlabs-sfx is shipped.

string

required

Description of the sound. Max 500 characters. Also accepts text as an alias.

number

Optional duration 0.5 to 22 seconds. Omit to let the model auto-pick a sensible length.

number

default:"0.3"

How literal the prompt should be (0 = creative, 1 = strict). Range 0–1.

string

default:"mp3_44100_128"

Audio format. Same options as audio/speech.

string

Optional query param. Set to 1 to have Kyma upload the resulting MP3 to Vercel Blob, write a multimodal_jobs row, and return JSON { job_id, kind: "audio", url, duration_sec, cost_usd, balance_usd } instead of streaming bytes. Used by Canvas and Muse audio kinds — most direct API callers don’t need this.

Response

Default (streaming)

200 OK with audio bytes. Flat pricing — duration doesn’t change the cost.

Header	What
`X-Kyma-Model`	`elevenlabs-sfx`
`X-Kyma-Cost-USD`	flat `$0.027` per generation
`X-Kyma-Balance-USD`	remaining balance

With `?save_to_blob=1`

200 OK with JSON:

{
  "object": "audio.generation",
  "job_id": "mmj_...",
  "kind": "audio",
  "model": "elevenlabs-sfx",
  "url": "https://blob.vercel-storage.com/mmj/.../mmj_....mp3",
  "duration_sec": 3,
  "cost_usd": 0.027,
  "balance_usd": 47.97
}

Errors

Status	`error.code`	When
`400`	`not_an_sfx_model`	`model` is not an SFX SKU
`400`	`prompt_too_long`	prompt > 500 chars
`400`	`invalid_duration`	`duration_seconds` outside `[0.5, 22]`
`401`	`auth_error`	missing or invalid API key
`402`	`billing_error`	balance too low
`502`	`provider_error`	upstream provider failure

Endpoints

Audio Sound Effects

Request

Response

Default (streaming)

With `?save_to_blob=1`

Errors

See also

​Request

​Response

​Default (streaming)

​With ?save_to_blob=1

​Errors

​See also

Request

Response

Default (streaming)

With `?save_to_blob=1`

Errors

See also