Skip to main content
Creates an environment for the project: a noise bed and the level it plays at. Reference it by id when setting a customer flow variant’s environment. Roark’s curated presets always play at the default level, so this is how a project gets the same bed louder or quieter.
Calls POST /v1/simulation/environment

​
Options

​
string
required
Display name, shown wherever a flow variant references the environment.
​
string
Optional note on when to use this environment.
​
string
required
The noise bed played underneath the simulated caller. NONE plays nothing. One of NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, CONSTRUCTION, CRYING_BABY, DRIVING, LIBRARY, OFFICE, THUNDERSTORM, TRAIN
​
number
How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller). Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints, which have no level control.

​
Example

Every command also takes the global options and sets one of the exit codes.