Skip to navigation
API OverviewRoom Playback

Set room playback volume

View as Markdown

Set the current room playback volume. volume is an integer from 0 through 200. A newly created room reports playback_volume: 0 before playback starts. Starting playback sets the volume to 100 (normal/unchanged); this command changes that value. 0 mutes playback, and values above 100 boost it up to 200.

This is relative gain, not target loudness. At 100, a file keeps its recorded loudness; the platform does not match loudness across files.

A 202 response confirms that the request was admitted for dispatch. It does not confirm that playback applied the change, and this operation emits no webhook. A new playback uses the default volume (100).

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See 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. An explicitly empty header is treated like omission and does not enable replay protection. See 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). A new room reports 0 before playback starts. Starting playback sets the volume to 100 (normal/unchanged); this command changes that value. 0 mutes, and values above 100 boost up to 200.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Room playback command accepted for asynchronous execution
operation_uuidstring
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable 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