API Reference

Sound effects

The sound effect dropdown in the editor, as a list. Uploaded effects from this workspace come first, then the built-in clips, in the same order and with the same names.

GET/v1/sound-effects

List sound effects

Returns every option the dropdown would show for this workspace. Pass value back as soundEffect on a fake text message.

Response fields

soundEffects[].namerequired

string

The label shown in the dropdown.

soundEffects[].valuerequired

string

What selecting that row stores. Pass it as soundEffect on a fake text message.

Request

curl "https://api.vsub.io/v1/sound-effects" \
  -H "Authorization: Bearer vp_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f90"

Response 200

{
  "soundEffects": [
    {
      "name": "door-knock.mp3",
      "value": "r2-user-audio-6c1a72f5-4b98-4e3a-8d16-9f2c0b7a5e31.mp3"
    },
    {
      "name": "Vine boom",
      "value": "https://storage.vsub.io/public-assets/client/sound-effects/vine-boom-2.mp3"
    },
    {
      "name": "iPhone noti 2",
      "value": "https://storage.vsub.io/public-assets/client/sound-effects/iphone-noti-2.mp3"
    }
  ]
}

Uploaded effects use the file's name and the stored audio key. Built-in clips use the dropdown label and the public url of the mp3. A built-in name such as iphone-noti-2 is still accepted as soundEffect, and it plays the same file as the matching row here.

{ "soundEffects": [ { "name": "door-knock.mp3", "value": "r2-user-audio-6c1a72f5-4b98-4e3a-8d16-9f2c0b7a5e31.mp3" }, { "name": "Vine boom", "value": "https://storage.vsub.io/public-assets/client/sound-effects/vine-boom-2.mp3" }, { "name": "iPhone noti 2", "value": "https://storage.vsub.io/public-assets/client/sound-effects/iphone-noti-2.mp3" } ] }