API OverviewRoom Playback

Set room playback volume

View as Markdown

Set room playback volume on a 0-200 scale: 100 = normal/unchanged (default), 0 = mute, values above 100 boost up to a maximum of 200.

This is relative gain, not target loudness — 100 leaves the file as recorded (a quiet file at 100 stays quiet); there is no automatic loudness matching across files.

The 202 response confirms admission.

Authentication

AuthorizationBearer
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

room_idstringRequired

Case-sensitive room identifier.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]+$"<=128 characters
Optional key for safely retrying mutating requests. See [Idempotency](https://voice-platform.docs.buildwithfern.com/idempotency) for details.
Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Request

This endpoint expects an object.
volumeintegerRequired0-200

Playback volume (0-200). 100 = normal/unchanged, 0 = mute, above 100 boosts up to 200.

Response

Room playback command accepted for asynchronous execution
operation_uuidstringformat: "uuid"
statusenum

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
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error