Robot

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).

Headers

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

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 · 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"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/robot/getAllMediaUris' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/robot/getAllMediaUris"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/robot/getAllMediaUris', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/getAllMediaUris"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "audioFacetUris": {
    "<key>": {
      "lanLiveOpusUris": [
        "<string>"
      ],
      "wanLiveOpusUri": "<string>"
    }
  },
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "lanCheckUrls": [
    "<string>"
  ],
  "videoFacetUris": {
    "<key>": {
      "lanLiveH264Uris": [
        "<string>"
      ],
      "lanLiveM3u8Uris": [
        "<string>"
      ],
      "lanLiveMpdUris": [
        "<string>"
      ],
      "lanVodM3u8UrisTemplates": [
        "<string>"
      ],
      "lanVodMpdUrisTemplates": [
        "<string>"
      ],
      "wanLiveH264Uri": "<string>",
      "wanLiveM3u8Uri": "<string>",
      "wanLiveMpdUri": "<string>",
      "wanVodM3u8UriTemplate": "<string>",
      "wanVodMpdUriTemplate": "<string>"
    }
  },
  "wanLiveRobotUri": "<string>"
}

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