Skip to main content
POST
audio.sound-effects.generate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
prompt
string
required

The sound to make, e.g. a door creaking open in an empty hall.

Required string length: 1 - 1000
durationSeconds
number

Length in seconds, 0.5 to 30. Default: the service decides, and the call is held for 30 seconds.

Required range: 0.5 <= x <= 30
loop
boolean
default:false

Make a sound that repeats smoothly. Default false.

influence
number

How closely the prompt is followed, 0 to 1. Higher is stricter.

Required range: 0 <= x <= 1

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.