Skip to content

REST API | OpenAPI

This page provides the downloadable OpenAPI descriptions and interactive endpoint reference for picoScan devices. For general REST API concepts, authentication, and request patterns, see REST API / OpenAPI.

OpenAPI Files

Sample OpenAPI descriptions:

Always match the file to your device's actual firmware version. Endpoints, parameters, and schemas change between releases.

Interactive Endpoint Reference

The full endpoint reference below is rendered directly from the OpenAPI files above. Expand an endpoint to see its parameters, request body, and response schema, or use Try it out against a reachable device. Writes still require challenge-response authentication.

For the general REST API explanation and authentication details, return to REST API / OpenAPI.

How to use the OpenAPI file with Insomnia.