Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
idempotency_key
string<uuid>
required

A unique UUID you choose. Send the same key to retry safely; we'll return the original response without doing the work again.

Example:

"3f2b8c1e-9d4a-4e7b-b6c5-1a2d3e4f5a6b"

prompt
string
required

Free-text description of the sound effect to generate, up to 450 characters. Describe the sound itself and its character — the source, the action and the setting. Examples: someone typing on a keyboard, a deep cinematic impact with a long metallic tail, rising whoosh transition.

Required string length: 1 - 450
duration
number
required

Duration in seconds.

callback_url
string<uri> | null

Optional HTTPS URL we'll POST the final response to when the operation reaches ready or failed. Polling remains the canonical source of truth; webhooks are a best-effort latency optimisation.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks/soundpiece"

Response

Successful Response

fx
Fx · object
required