Skip to content
Revolution™
Sign in Get started

REST API

The Revolution REST API is available to external plugins using a plugin JWT, obtained from the token-exchange endpoint (POST /api/v1/{tenantId}/external-plugin/oauth/token — an RFC 6749 authorization_code exchange with PKCE and private_key_jwt; the request and response shapes are documented in the API Reference below). Tokens are tenant-bound: they are only valid on routes for the tenant they were issued for.

Global request parameters

Section titled “Global request parameters”

These apply to every operation except the token exchange (which is standard OAuth and always returns its RFC 6749 shapes) and are not repeated in the per-endpoint reference:

  • X-Envelope (header, optional) — responses are raw JSON payloads by default, and errors return a compact { "message": "...", "code": "..." } body. Send X-Envelope: true to receive the wrapped ApiResponse shape (state / data / isSuccess / …) for successes and errors alike.
  • api-version (query, optional) — the version is already in the URL path (/api/v1/...); the query parameter never needs to be sent.

Browse the API

Section titled “Browse the API”
API Reference Every endpoint, every parameter — devices, labware, storage, schedules and more, generated from the OpenAPI spec.

Prefer machine-readable? Download the spec: plugin-v1.openapi.json — it is regenerated from the running API surface whenever the plugin-accessible endpoints change.