Skip to main content
GET
Get

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_id
string
required

The unique identifier of the component.

Example:

"cmp_123"

Query Parameters

​
expand
enum<string>[]

Fields to expand on the component.

Available options:
roles,
aspects
Example:

Response

200 - application/json

Successfully retrieved the component.

A kind of hardware on a device whose calibrations Miru stores, such as an arm or a camera. Miru creates a component the first time a device reports a calibration with a new slug; components are never created, archived, or deleted through the API. A workspace holds at most 100 components.

​
object
enum<string>
required

The object type, which is always component.

Available options:
component
Example:

"component"

​
id
string
required

ID of the component.

Example:

"cmp_123"

​
name
string
required

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

Example:

"Arm"

​
slug
string
required

An immutable, code-friendly name for the component, validated like config type slugs. Component slugs and config type slugs are separate namespaces, so a component may share a slug with a config type.

Example:

"arm"

​
created_at
string<date-time>
required

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

Example:

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

​
updated_at
string<date-time>
required

Timestamp of when the component was last updated.

Example:

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

​
roles
Component Role · object[]

The component's roles, in the order first reported. Miru adds a role the first time a device reports it and never removes one. At most 100. Expand using expand=roles in the query string.

Maximum array length: 100
Example:
​
aspects
Component Aspect · object[]

The component's aspects, in the order first reported. Miru adds an aspect the first time a device reports it and never removes one. At most 100. Expand using expand=aspects in the query string.

Maximum array length: 100
Example: