Skip to content

Get media uris for every configured facet of a robot

Get the video uris of every video facet and the audio uris of every audio facet the robot has configured, so no uri is minted under a facet that cannot serve it

POST/api/robot/getAllMediaUris

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for retrieving the media uris of every facet a robot has configured.

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Response

200 OK

application/json · object

Media uris for every configured facet of a robot, plus the robot's device-level uris.

audioFacetUrisobject | null

Audio uris keyed by the audio facet that serves them

Show child attributes
lanLiveOpusUrisstring[] | null

List of LAN URIs for the live Opus audio stream of this facet

wanLiveOpusUristring | null

WAN URI for the live Opus audio stream of this facet

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lanCheckUrlsstring[] | null

List of LAN check URLs to verify robot availability on the local network. Not faceted

videoFacetUrisobject | null

Video uris keyed by the video facet that serves them

Show child attributes
lanLiveH264Urisstring[] | null

List of LAN URIs for the live realtime video stream of this facet

lanLiveM3u8Urisstring[] | null

List of LAN URIs for the live M3U8 stream of this facet

lanLiveMpdUrisstring[] | null

List of LAN URIs for the live MPD stream of this facet

lanVodM3u8UrisTemplatesstring[] | null

List of LAN URI templates for VOD M3U8 streams of this facet

lanVodMpdUrisTemplatesstring[] | null

List of LAN URI templates for VOD MPD streams of this facet

wanLiveH264Uristring | null

WAN URI for the live realtime video stream of this facet

wanLiveM3u8Uristring | null

WAN URI for the live M3U8 stream of this facet

wanLiveMpdUristring | null

WAN URI for the live MPD stream of this facet

wanVodM3u8UriTemplatestring | null

WAN URI template for VOD M3U8 streams of this facet

wanVodMpdUriTemplatestring | null

WAN URI template for VOD MPD streams of this facet

wanLiveRobotUristring | null

WAN URI for the robot control websocket. Not faceted