List available background noise assets

curl --request GET \
  --url https://api.kupe.in/api/v1/noise-assets \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "office_noise.wav",
    "name": "office_noise"
  },
  {
    "id": "office_ambience_sound.wav",
    "name": "office_ambience_sound"
  }
]

Noise Assets

List available background noise assets

Full URL: GET https://api.kupe.in/api/v1/noise-assets

Returns every outbound background noise WAV the platform can mix under agent speech on live calls. Use each item’s id as agent_specific_config.background_noise_id on POST /api/v1/agents or PUT /api/v1/agents/{agent_id}.

No background voice: omit background_noise_id, or set it to null or "" on update to clear a previous selection. Optionally set background_noise_volume to 0 to mute while keeping an id.

See the page body (MDX) for examples, field tables, and curl workflows.

GET

api

noise-assets

List available background noise assets

curl --request GET \
  --url https://api.kupe.in/api/v1/noise-assets \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "office_noise.wav",
    "name": "office_noise"
  },
  {
    "id": "office_ambience_sound.wav",
    "name": "office_ambience_sound"
  }
]

Authorizations

x-api-key

string

header

default:YOUR_KUPE_API_KEY

required

Kupe dashboard API key for your user.

Response

Array of noise asset rows.

string

required

Asset identifier — use as background_noise_id (e.g. office_noise.wav or office_noise without extension).

name

string

required

Display label derived from the filename (without .wav).

List TTS voice catalog rows Get all phone numbers