API reference
Interactive views of the OpenAPI schemas committed with the docs site: endpoint details, request and response models, authentication requirements, and schema downloads.
- Public API: the application API for platform data, accounts, authentication, media, and public research records. Use this unless you are building a device integration.
- Device API: the backend-facing API for pairing devices and Relab plugins with the platform.
- RPi camera API: the local camera service API for status checks, capture workflows, and camera-device integration.
Licensing
Section titled “Licensing”The public and device schemas, and the client types generated from them, are Apache-2.0, not AGPL: a generated client carries no copyleft obligation into your code. The RPi camera schema comes from a separate repository and is not covered by that carve-out. See Licensing.
For scripting guidance, see the API interaction guide. For the implementation, see API structure.