API and developer docs
Everything Formcloud does is available over the API, and everything a device records is available as a stream. The full reference lives in the developer console.
- REST API
- Formcloud API v3, JSON over HTTPS
- Streams
- MQTT 5 over TLS 1.3
- Auth
- OAuth 2.0 client credentials
- SDKs
- Python, Java, TypeScript
- Sandbox
- Simulated fleet of 200 devices
What is in the docs
The developer console holds the full reference. This is what you will find there.
Formcloud REST API
Devices, groups, programs, assignments, firmware rollouts, rules and audit events.
- OpenAPI 3.1 specification
- Cursor pagination, idempotency keys
- Rate limits per client, published
Device data streams
Live and replayed measurement streams by program or device group.
- MQTT 5 topics per program
- Replay from any point in the retention window
- Delayed-reading flags preserved
SDKs
Maintained client libraries that handle authentication, retries and pagination.
- Python 3.10 and later
- Java 17 and later
- TypeScript for Node 20 and later
Sandbox
A simulated fleet that behaves like a real one, including the failures.
- 200 virtual devices across all families
- Scheduled outages and battery failures
- Resettable on demand
Research data dictionary
For research institutions working with exported device data.
The data dictionary describes every field in a research export: what it means, how it was measured, its units, and the device and firmware conditions that produced it.
It covers Axon Sense, Corta and Lattice bench exports, including the provenance fields we attach to every recording: device serial, firmware build hash, calibration record, front-end configuration and time synchronization quality. It is versioned alongside the export format, so a dataset and its dictionary always match.
The current version is in the developer console. If your institution does not have console access yet, our research team will send the dictionary directly and set up access for your group.
Request the data dictionary
Write to research@nexaformlabs.com with your institution and study name, or talk to the research team.
Getting access
Customers
Your Formcloud administrator creates API clients for your tenancy in the developer console.
Research partners
Access is set up per study, scoped to the programs and exports the study covers.
Device partners
Lattice OS partners get the platform SDK and documentation with their license.
Just exploring
The sandbox is open to anyone with a developer console account. No contract needed.
Building an integration?
Start in the sandbox, then talk to us before go-live. We would rather review your retry logic now than after an outage.