# Miru

## Docs

- [API Keys](https://docs.mirurobotics.com/docs/admin/apikeys.md)
- [Invites](https://docs.mirurobotics.com/docs/admin/users/invites.md)
- [Manage members](https://docs.mirurobotics.com/docs/admin/users/manage.md)
- [Overview](https://docs.mirurobotics.com/docs/admin/users/overview.md)
- [Your profile](https://docs.mirurobotics.com/docs/admin/users/profile.md)
- [Roles](https://docs.mirurobotics.com/docs/admin/users/roles.md)
- [Workspace](https://docs.mirurobotics.com/docs/admin/workspace.md)
- [Agent](https://docs.mirurobotics.com/docs/changelogs/agent.md): Changelog and migration steps for the Miru Agent
- [CLI](https://docs.mirurobotics.com/docs/changelogs/cli.md): Changelog and migration steps for the Miru CLI
- [Device API](https://docs.mirurobotics.com/docs/changelogs/device-api.md): Changelog and migration steps for the Device API
- [Platform API](https://docs.mirurobotics.com/docs/changelogs/platform-api.md): Changelog and migration steps for the Platform API
- [Product](https://docs.mirurobotics.com/docs/changelogs/product.md)
- [Architecture](https://docs.mirurobotics.com/docs/developers/agent/architecture.md)
- [Commands](https://docs.mirurobotics.com/docs/developers/agent/commands.md)
- [File Permissions](https://docs.mirurobotics.com/docs/developers/agent/file-permissions.md)
- [Install](https://docs.mirurobotics.com/docs/developers/agent/install.md)
- [Overview](https://docs.mirurobotics.com/docs/developers/agent/overview.md)
- [Security](https://docs.mirurobotics.com/docs/developers/agent/security.md)
- [Versions](https://docs.mirurobotics.com/docs/developers/agent/versions.md)
- [GitHub Actions](https://docs.mirurobotics.com/docs/developers/ci/gh-actions.md)
- [Overview](https://docs.mirurobotics.com/docs/developers/ci/overview.md)
- [Install](https://docs.mirurobotics.com/docs/developers/cli/install.md)
- [Login](https://docs.mirurobotics.com/docs/developers/cli/login.md)
- [Overview](https://docs.mirurobotics.com/docs/developers/cli/overview.md)
- [Authentication](https://docs.mirurobotics.com/docs/developers/device-api/authn.md)
- [Server-sent events](https://docs.mirurobotics.com/docs/developers/device-api/events.md): Subscribe to real-time events from the Miru Agent via Server-Sent Events (SSE).
- [Overview](https://docs.mirurobotics.com/docs/developers/device-api/overview.md)
- [SDKs](https://docs.mirurobotics.com/docs/developers/device-api/sdks.md)
- [Versions](https://docs.mirurobotics.com/docs/developers/device-api/versions.md)
- [Authentication](https://docs.mirurobotics.com/docs/developers/platform-api/authn.md)
- [Authorization](https://docs.mirurobotics.com/docs/developers/platform-api/authz.md)
- [Overview](https://docs.mirurobotics.com/docs/developers/platform-api/overview.md)
- [Expansions](https://docs.mirurobotics.com/docs/developers/platform-api/query-params/expansions.md)
- [Filtering](https://docs.mirurobotics.com/docs/developers/platform-api/query-params/filtering.md)
- [Pagination](https://docs.mirurobotics.com/docs/developers/platform-api/query-params/pagination.md)
- [Sorting](https://docs.mirurobotics.com/docs/developers/platform-api/query-params/sorting.md)
- [SDKs](https://docs.mirurobotics.com/docs/developers/platform-api/sdks.md)
- [Versioning](https://docs.mirurobotics.com/docs/developers/platform-api/versioning.md)
- [Concepts](https://docs.mirurobotics.com/docs/getting-started/concepts.md)
- [Overview](https://docs.mirurobotics.com/docs/getting-started/intro.md)
- [Create a release](https://docs.mirurobotics.com/docs/getting-started/quick-start/create-release.md)
- [Deploy configs](https://docs.mirurobotics.com/docs/getting-started/quick-start/deploy-configs.md)
- [Install the agent](https://docs.mirurobotics.com/docs/getting-started/quick-start/install-agent.md)
- [Overview](https://docs.mirurobotics.com/docs/getting-started/quick-start/overview.md)
- [Config instances](https://docs.mirurobotics.com/docs/learn/config-instances.md)
- [Config types](https://docs.mirurobotics.com/docs/learn/config-types.md)
- [Deployments](https://docs.mirurobotics.com/docs/learn/deployments.md)
- [Config editor](https://docs.mirurobotics.com/docs/learn/devices/config-editor.md)
- [Deployment history](https://docs.mirurobotics.com/docs/learn/devices/deployment-history.md)
- [Initial deployment](https://docs.mirurobotics.com/docs/learn/devices/initial-deployment.md)
- [Manage devices](https://docs.mirurobotics.com/docs/learn/devices/manage.md)
- [Overview](https://docs.mirurobotics.com/docs/learn/devices/overview.md)
- [Provision devices](https://docs.mirurobotics.com/docs/learn/devices/provision.md)
- [Create releases](https://docs.mirurobotics.com/docs/learn/releases/create.md)
- [Deployment history](https://docs.mirurobotics.com/docs/learn/releases/deployment-history.md)
- [Manage releases](https://docs.mirurobotics.com/docs/learn/releases/manage.md)
- [Overview](https://docs.mirurobotics.com/docs/learn/releases/overview.md)
- [Staging area](https://docs.mirurobotics.com/docs/learn/releases/staging-area.md)
- [CUE](https://docs.mirurobotics.com/docs/learn/schemas/languages/cue.md)
- [JSON Schema](https://docs.mirurobotics.com/docs/learn/schemas/languages/jsonschema.md)
- [Overview](https://docs.mirurobotics.com/docs/learn/schemas/languages/overview.md)
- [Manage schemas](https://docs.mirurobotics.com/docs/learn/schemas/manage.md)
- [Overview](https://docs.mirurobotics.com/docs/learn/schemas/overview.md)
- [Create](https://docs.mirurobotics.com/docs/references/cli/release-create.md)
- [Health](https://docs.mirurobotics.com/docs/references/device-api/v0.1.0/endpoints/agent/health.md): Retrieve the health of the agent.
- [Version](https://docs.mirurobotics.com/docs/references/device-api/v0.1.0/endpoints/agent/version.md): Retrieve the version of the agent.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.1.0/endpoints/devices/get.md): Retrieve the device.
- [Sync](https://docs.mirurobotics.com/docs/references/device-api/v0.1.0/endpoints/devices/sync.md): Manually force a device sync with the edits made in the dashboard.
- [Health](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/agent/health.md): Retrieve the health of the agent.
- [Version](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/agent/version.md): Retrieve the version of the agent.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/deployments/get.md): Retrieve a deployment by its ID.
- [Get Current](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/deployments/get-current.md): Get the current deployment for the device.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/device/get.md): Retrieve the device.
- [Sync](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/device/sync.md): Manually force a device sync with the edits made in the dashboard.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/git-commits/get.md): Retrieve a git commit by its ID.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/releases/get.md): Retrieve a release by its ID.
- [Get Current](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0/endpoints/releases/get-current.md): Retrieve the current release.
- [Health](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/agent/health.md): Retrieve the health of the agent.
- [Version](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/agent/version.md): Retrieve the version of the agent.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/deployments/get.md): Retrieve a deployment by its ID.
- [Get Current](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/deployments/get-current.md): Get the current deployment for the device.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/device/get.md): Retrieve the device.
- [Sync](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/device/sync.md): Manually force a device sync with the edits made in the dashboard.
- [Stream Events](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/events/stream-events.md): Subscribe to a Server-Sent Events (SSE) stream of agent lifecycle events.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/git-commits/get.md): Retrieve a git commit by its ID.
- [Get](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/releases/get.md): Retrieve a release by its ID.
- [Get Current](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/endpoints/releases/get-current.md): Retrieve the current release.
- [deployment.deployed](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/events/deployment-deployed.md): A deployment's config instances have been written to the device's filesystem.
- [deployment.removed](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/events/deployment-removed.md): A deployment's config instances have been removed from the device's filesystem.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/config-instances/get.md): Retrieve a config instance by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/config-instances/list.md): List config instances.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/deployments/create.md): Stage or deploy a new deployment.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/deployments/get.md)
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/deployments/list.md)
- [Activation Token](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/activation-token.md): Create a new device activation token.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/create.md): Create a new device.
- [Delete](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/delete.md): Delete a device by ID.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/get.md): Get a device by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/list.md): List devices.
- [Update](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/devices/update.md): Update a device by ID.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/releases/get.md): Retrieve a release by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21/endpoints/releases/list.md): List releases.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-instances/create.md): Create a new config instance.
- [Download Content](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-instances/download-content.md): Download the content of a config instance.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-instances/get.md): Retrieve a config instance by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-instances/list.md): List config instances.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-schemas/create.md): Create a new config schema.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-schemas/get.md): Retrieve a config schema by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-schemas/list.md): List config schemas.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-types/create.md): Create a new config type.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-types/get.md): Retrieve a config type by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-types/list.md): List config types.
- [Update](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/config-types/update.md): Update a config type by ID.
- [Archive](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/archive.md): Archive staged or drifted deployments.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/create.md): Stage or deploy a new deployment.
- [Deploy](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/deploy.md): Trigger a deployment to its target device.
- [Drifts](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/drifts.md): List the deployments which have been deployed since this deployment was staged.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/get.md): Retrieve a deployment by its ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/deployments/list.md): List all deployments.
- [Activation Token](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/activation-token.md): Create a new device activation token.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/create.md): Create a new device.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/get.md): Get a device by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/list.md): List devices.
- [Ping](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/ping.md): Ping a device to check connectivity.
- [Update](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/devices/update.md): Update a device by ID.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/git-commits/create.md): Register a git commit.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/git-commits/get.md): Retrieve a git commit by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/git-commits/list.md): List git commits.
- [Self](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/principals/self.md): Retrieve the currently authenticated principal.
- [Create](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/releases/create.md): Create a new release.
- [Get](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/releases/get.md): Retrieve a release by ID.
- [List](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09/endpoints/releases/list.md): List releases.

## OpenAPI Specs

- [2026-03-09](https://docs.mirurobotics.com/docs/references/platform-api/2026-03-09.yaml)
- [api](https://docs.mirurobotics.com/docs/references/device-api/v0.2.1/api.yaml)
- [example](https://docs.mirurobotics.com/tests/lint-fixtures/good/docs/references/example.yaml)
- [2025-10-21](https://docs.mirurobotics.com/docs/references/platform-api/2025-10-21.yaml)
- [v0.2.0](https://docs.mirurobotics.com/docs/references/device-api/v0.2.0.yaml)
- [v0.1.0](https://docs.mirurobotics.com/docs/references/device-api/v0.1.0.yaml)