Overview
What the xPlant API is for, how it's shaped, and where to start.
The xPlant API connects your lab's own systems to your xPlant workspace: schedulers and spreadsheets, bench stations and label scanners, sensors and gateways, and storefronts. Anything your integration can do, it does inside one workspace, with only the permissions you gave its key.
The shape of every call
- One host. Everything lives under
https://app.xplantpro.com/api/v1. (www.xplantpro.comis the marketing site; API calls there are refused.) - One header.
Authorization: Bearer <key>. Workspace keys start withxpk_; device tokens start withxpd_. - One envelope. Success is
{ "ok": true, "data": … }. Failure is{ "ok": false, "data": null, "error": "…", "code": "STABLE_CODE" }. Branch oncode. - Scopes you choose. A key can do exactly what its scopes allow, and nothing else. There is no default set.
- Bounded by your plan and your role. Teams and Enterprise include the whole API; Hobby and Pro Lab keys can connect devices only. A key never does more than its owner can in xPlant. See Plans and access.
Start here
Quickstart
Create a key and make your first call in five minutes.
Authentication and API keys
Keys, device tokens, and keeping them safe.
Scopes
All 34 scopes and what each one unlocks.
API reference
Every endpoint, generated from the OpenAPI spec.
What you can build
Sync tasks
Drive the bench queue from your own scheduler, without overriding people.
Push demand signals
Tell xPlant what's selling so the right work rises to the top.
Record transfers and stages
Log subcultures and stage changes from a script or a scanner.
Run an SOP from a bench station
Start runs, confirm steps, and post measurements with units.
Label scanning
Resolve a QR or barcode to its record, and log the scan.
Sensors and devices
Stream readings from a Pi or an ESP32 with a device token.
Equipment events
Let an autoclave or a pH meter report usage and calibration.
Pull change history
Mirror plant and explant edits into your own system.
Help
Email support@xplantpro.com, or see xPlant support. For what each plan includes, see plans and pricing. For security issues, see the repository's security policy.