Skip to main content
POST
Create background sound upload

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
display_name
string
required
Required string length: 1 - 200
Example:

"Lobby Noise"

original_filename
string
required
Required string length: 1 - 255
Example:

"lobby-noise.mp3"

content_type
enum<string>
required

WAV or MP3 content type.

Available options:
audio/mpeg,
audio/mp3,
audio/wav,
audio/x-wav,
audio/wave,
audio/vnd.wave
default_volume
number<float>
default:0.3
Required range: x >= 0
acoustic_source_type
enum<string> | null

Acoustic rendering behavior for this sound.

  • ambient: mixed like room ambience.
  • point_source: rendered from a specific location when a situate_speaker preset is set; otherwise mixed like ambient.
Available options:
ambient,
point_source
metadata
object

Response

Upload created successfully

background_sound
object
required
upload_url
string
required

Presigned S3 POST URL.

upload_fields
object
required

Form fields to include in the multipart upload POST before the file field.

expires_at
string<date-time>
required
max_size_bytes
integer
required
Example:

52428800