Get - Miru

GET

/

component_roles

/

{component_role_id}

Get

curl --request GET \
  --url https://api.mirurobotics.com/beta/component_roles/{component_role_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.mirurobotics.com/beta/component_roles/{component_role_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/component_roles/{component_role_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/component_roles/{component_role_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/component_roles/{component_role_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/component_roles/{component_role_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/component_roles/{component_role_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "component_role",
  "id": "cmp_rol_123",
  "component_id": "cmp_123",
  "slug": "front-left",
  "name": "Front Left",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Scope	Required
`component_roles:read`	Yes

Authorizations

X-API-Key

string

header

required

The API key to use for authentication.

Headers

Miru-Version

string

required

The API version the client was built against.

Example:

"2026-10-28.everglades"

Path Parameters

component_role_id

string

required

The unique identifier of the component role.

Example:

"cmp_rol_123"

Query Parameters

expand

enum<string>[]

Fields to expand on the component role.

Available options:

component

Example:

["component"]

Response

200 - application/json

Successfully retrieved the component role.

A role a calibrated unit fills on a device, such as left or front-left. Miru creates a role the first time a device reports a calibration with a new role for the component; roles are never created or deleted through the API. A component holds at most 100 roles.

object

enum<string>

required

The object type, which is always component_role.

Available options:

component_role

Example:

"component_role"

id

string

required

ID of the role.

Example:

"cmp_rol_123"

component_id

string

required

ID of the component the role belongs to.

Example:

"cmp_123"

slug

string

required

The immutable value devices report as role when they create a calibration, unique within the component.

Example:

"front-left"

name

string

required

Display name of the role. Defaults to a name inferred from the slug, with words split on - and _ and each capitalized (front-left becomes Front Left). Publishers can rename it.

Example:

"Front Left"

created_at

string<date-time>

required

Timestamp of when Miru created the role, which is when a device first reported a calibration with its slug for the component.

Example:

"2021-01-01T00:00:00Z"

updated_at

string<date-time>

required

Timestamp of when the role was last updated.

Example:

"2021-01-01T00:00:00Z"

component

Component · object

The component the role belongs to. Expand using expand=component in the query string.

Show child attributes

Example:

{
  "object": "component",
  "id": "cmp_123",
  "name": "Arm",
  "slug": "arm",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

⌘I

Get

curl --request GET \
  --url https://api.mirurobotics.com/beta/component_roles/{component_role_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.mirurobotics.com/beta/component_roles/{component_role_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/component_roles/{component_role_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/component_roles/{component_role_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/component_roles/{component_role_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/component_roles/{component_role_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/component_roles/{component_role_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "component_role",
  "id": "cmp_rol_123",
  "component_id": "cmp_123",
  "slug": "front-left",
  "name": "Front Left",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}