Skip to main content
POST
/
v1
/
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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.kymaapi.com/llms.txt

Use this file to discover all available pages before exploring further.

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.
​
model
string
default:"elevenlabs-sfx"
SFX model. Currently only elevenlabs-sfx is shipped.
​
prompt
string
required
Description of the sound. Max 500 characters. Also accepts text as an alias.
​
duration_seconds
number
Optional duration 0.5 to 22 seconds. Omit to let the model auto-pick a sensible length.
​
prompt_influence
number
default:"0.3"
How literal the prompt should be (0 = creative, 1 = strict). Range 0–1.
​
response_format
string
default:"mp3_44100_128"
Audio format. Same options as audio/speech.

​
Response

200 OK with audio bytes. Flat pricing — duration doesn’t change the cost.
HeaderWhat
X-Kyma-Modelelevenlabs-sfx
X-Kyma-Cost-USDflat $0.027 per generation
X-Kyma-Balance-USDremaining balance

​
Errors

Statuserror.codeWhen
400not_an_sfx_modelmodel is not an SFX SKU
400prompt_too_longprompt > 500 chars
400invalid_durationduration_seconds outside [0.5, 22]
401auth_errormissing or invalid API key
402billing_errorbalance too low
502provider_errorupstream provider failure

​
See also