List

Authorizations

X-API-Key

string

header

required

The API key to use for authentication. Retrieve your API key from the Miru dashboard.

Query Parameters

offset

integer

default:0

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0

limit

integer

default:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100

order_by

enum<string>

default:created_at:desc

The order to sort the releases.

Available options:

id:asc,

id:desc,

created_at:desc,

created_at:asc

expand[]

enum<string>[]

The fields to expand in the releases list.

Available options:

total_count,

config_schemas

string

The release ID to filter by.

Example:

"rls_123"

version

string

The release version to filter by.

Example:

"v1.0.0"

Response

200 - application/json

Successfully listed the releases.

object

enum<string>

required

Available options:

list

Example:

"list"

total_count

integer<int64>

required

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand[]=total_count) to get the total number of items in the list.

limit

integer

default:10

required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100

offset

integer

default:0

required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0

has_more

boolean

required

True if there are more items in the list to return. False if there are no more items to return.

Example:

false

data

Release · object[]

required

Hide child attributes

data.object

enum<string>

required

Available options:

release

Example:

"release"

data.id

string

required

ID of the release.

Example:

"rls_123"

data.version

string

required

The version of the release.

Example:

"v1.0.0"

data.created_at

string<date-time>

required

Timestamp of when the release was created.

Example:

"2024-01-01T00:00:00Z"

data.updated_at

string<date-time>

required

Timestamp of when the release was last updated.

Example:

"2024-01-01T00:00:00Z"

data.config_schemas

Config Schema · object[] | null

required

Expand the config schemas using 'expand[]=config_schemas' in the query string.

Hide child attributes

data.config_schemas.object

enum<string>

required

Available options:

config_schema

Example:

"config_schema"

data.config_schemas.id

string

required

ID of the config schema.

Example:

"cfg_sch_123"

data.config_schemas.version

integer

required

Config schema version for the config type.

Example:

2

data.config_schemas.digest

string

required

Hash of the config schema contents.

Example:

"1234567890"

data.config_schemas.relative_filepath

string

required

The file path to deploy the config instance relative to /srv/miru/config_instances. v1/motion-control.json would deploy to /srv/miru/config_instances/v1/motion-control.json.

Example:

"/v1/motion-control.json"

data.config_schemas.created_at

string<date-time>

required

Timestamp of when the config schema was created.

Example:

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

data.config_schemas.updated_at

string<date-time>

required

Timestamp of when the config schema was last updated.

Example:

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

data.config_schemas.config_type_id

string

required

ID of the config type.

Example:

"cfg_typ_123"

data.config_schemas.content

object

required

The config schema's JSON Schema definition.

Example:

{
  "title": "Robot Features",
  "type": "object",
  "properties": {
    "enable_autonomy": { "type": "boolean", "default": true },
    "enable_remote_control": { "type": "boolean", "default": true },
    "max_payload_kg": {
      "type": "number",
      "minimum": 0,
      "maximum": 99,
      "default": 10
    },
    "preferred_speed_mode": {
      "type": "string",
      "enum": ["slow", "normal", "fast"],
      "default": "normal"
    },
    "emergency_stop_sensitivity": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "default": 0.8
    },
    "telemetry": {
      "type": "object",
      "properties": {
        "upload_interval_sec": {
          "type": "integer",
          "minimum": 10,
          "maximum": 600,
          "default": 60
        },
        "heartbeat_interval_sec": {
          "type": "integer",
          "minimum": 1,
          "maximum": 60,
          "default": 10
        }
      },
      "required": [
        "upload_interval_sec",
        "heartbeat_interval_sec"
      ]
    }
  },
  "required": [
    "enable_autonomy",
    "enable_remote_control",
    "max_payload_kg",
    "preferred_speed_mode",
    "emergency_stop_sensitivity",
    "telemetry"
  ]
}

data.config_schemas.config_type

Config Type · object

required

Expand the config type using 'expand[]=config_type' in the query string.

Hide child attributes

data.config_schemas.config_type.object

enum<string>

required

Available options:

config_type

Example:

"config_type"

data.config_schemas.config_type.id

string

required

ID of the config type.

Example:

"cfg_123"

data.config_schemas.config_type.name

string

required

Name of the config type.

Example:

"My Config Type"

data.config_schemas.config_type.slug

string

required

An immutable, code-friendly name for the config type.

Example:

"my-config-type"

data.config_schemas.config_type.created_at

string<date-time>

required

Timestamp of when the config type was created.

Example:

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

data.config_schemas.config_type.updated_at

string<date-time>

required

Timestamp of when the config type was last updated.

Example:

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

Example:

null

Example:

[]

Server-Side API

SDKs

Endpoints

Webhooks

Authorizations

Query Parameters

Response