Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt

Use this file to discover all available pages before exploring further.

Miru provides SDKs to help you build local applications and on-device tooling on top of the Device API. The SDKs provide typed request and response models, handle Unix socket access to the local agent, and offer both sync and async clients so integrations are faster to build and easier to maintain.

​
Versioning

Each SDK release is built against a specific Device API version. For example, Python SDK v0.3.0 targets Device API v0.2.0. We recommend using an SDK for the API version it was built against. However, SDKs may be used with newer API versions as long as the API changes are backward-compatible (see API Versioning). For example, an SDK released for Device API v0.2.0 can safely be used with Device API v0.2.x since it is guaranteed to be backward-compatible. Of course, older SDKs may not contain all the features of the latest API version. To use features introduced in a newer API version, upgrade to an SDK version built for that API version. To see which SDK versions are available for a given API version, you can find a compatibility matrix for each language below.

​
Python

The Python Device SDK provides convenient access to the Device API from any Python application. Below are the SDK versions released for a given API version.
API VersionSDK Versions
v0.2.1v0.4.x
v0.2.0v0.3.x
v0.1.0v0.1.x - v0.2.x
The v0.1.0 API version uses the legacy python-agent-sdk repository and the miru_agent_sdk import path. See .
For detailed documentation, examples, and advanced usage, visit the Python Device SDK repository.

python-device-sdk

Official Python SDK for the Miru Device API.

​
SSE support

The Device API SDKs do NOT support Server-Sent Events natively. While the SDKs do generate the event types from the OpenAPI specification, a dedicated SDK method for streaming events is not yet available. To consume the SSE stream, use a standard SSE client library for your language. Then, parse the data field of the event data object by discriminating on the type field in the event envelope (see Event Data).
Support for SSE will be added to the Device API SDKs in a future release.

​
OpenAPI specifications

If you’re using a language not yet supported by an official SDK, you can still generate client code from the OpenAPI specification. All OpenAPI specifications are available for download from the page.
Last modified on April 23, 2026