Vorbal API Documentation

Set the volume for a single room member, addressed by the member’s session UUID. This setting is independent of the room playback volume (POST /rooms/{room_id}/playback/volume).

Member volume uses a coarse 1-9 notch scale:

1: quietest
5: normal/unchanged
9: loudest

This differs from the 0-200 room playback scale. 1 is the quietest setting but is NOT silence; to silence a member use the mute command instead.

direction is named relative to the Room member:

to_member: how loudly the member hears the Room
from_member: how loudly the Room hears the member
both: apply the setting in both directions

The response acknowledges asynchronous admission. Exactly one terminal webhook follows:

room.member.volume_changed after every requested direction succeeds.
room.member.volume_change_failed after a confirmed full or partial execution failure.

See Room lifecycle, member, and playback events for complete payload schemas and examples.

Set the volume for a single [room member](/api/room-members), addressed by the member's session UUID. This setting is independent of the room playback volume (`POST /rooms/{room_id}/playback/volume`). Member volume uses a coarse 1-9 notch scale: - `1`: quietest - `5`: normal/unchanged - `9`: loudest This differs from the 0-200 room playback scale. `1` is the quietest setting but is NOT silence; to silence a member use the mute command instead. `direction` is named relative to the Room member: - `to_member`: how loudly the member hears the Room - `from_member`: how loudly the Room hears the member - `both`: apply the setting in both directions The response acknowledges asynchronous admission. Exactly one terminal webhook follows: - `room.member.volume_changed` after every requested direction succeeds. - `room.member.volume_change_failed` after a confirmed full or partial execution failure. See [Room lifecycle, member, and playback events](/api/rooms#lifecycle-member-and-playback-events) for complete payload schemas and examples.

Authentication

AuthorizationBearer

Application auth. Send Authorization: Bearer <app_uuid>:<api_key> using any active key in the app’s collection. See Authentication for details.

Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>` using any active key in the app's collection. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session identifier.

Headers

Request

This endpoint expects an object.

directionenumRequired

Room-member-relative direction. to_member = member hears Room; from_member = Room hears member; both = both.

Allowed values:

volumeintegerRequired1-9

Member volume (1-9). 5 = normal/unchanged, 1 = quietest, 9 = loudest.

Response

Command accepted for async execution

operation_uuidstringformat: "uuid"

statusenum

already_endedtrueOptional

Optional. Set to true on idempotent terminal commands when the session was already in a terminal state at the time the request was received. Absent otherwise.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

415

Unsupported Media Type Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error