Skip to main content
POST
Play audio upload

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request to play an uploaded audio clip through audio devices.

audioGatewayUuids
(string<DeviceFacetUuid> | null)[] | null

List of audio gateway device UUIDs to play audio through

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

audioUploadUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

loopDurationSec
integer<int32> | null
int32

Duration in seconds to loop the audio playback

Example:

30

playCount
integer<int32> | null
int32

Number of times to play the audio clip

Example:

1

Response

200 - application/json

OK

Response from playing an uploaded audio clip.

error
boolean | null
errorMsg
string | null
success
boolean | null

Indicates if audio playback was successful

Example:

true

warningMsg
string | null
Last modified on August 3, 2026