Background Noise

Base URL: examples use <vaanii_api_base_url> in place of the Vaanii API address. Contact the Vaanii team at team@vaanii.ai to get it.

FieldTypeDescription
background_noise_configobject | nullAmbient noise mixed into the bot's outbound audio. null = feature off.

Structure:

json
{
  "enabled": true,
  "source": "custom",
  "sound": "custom",
  "volume": 0.4,
  "asset": {
    "filename": "office-room-tone.wav",
    "gcs_path": "gs://vaanii-assets/background-noise/office-room-tone.wav"
  }
}
Sub-fieldTypeDescription
enabledbooleanTurn the ambience on. Default: false.
sourcestringbuiltin (default, pre-recorded library) or custom (your own uploaded clip).
soundstringoffice (default) · crowd · cafe · custom. custom is only valid when source is custom.
volumefloatMixing volume 0.0 – 1.0. Default: 0.4.
assetobject | nullThe uploaded clip {filename, gcs_path, ...}; required when source is custom.