api reference links
the interactive endpoint reference is rendered from the OpenAPI contract and is served at /docs/api.
- production: https://owlette.app/docs/api
- local dev: http://localhost:3000/docs/api
- raw json:
/api/openapi - source contract:
web/openapi.yaml
the rendered reference is generated from web/openapi.yaml and includes examples, operation-level authentication, and scope notes for documented operations; compatibility routes not present in the spec are omitted.
Use the shared convention pages for behavior that applies across operations: authentication, pagination, idempotency, errors, and rate limits.
run this before publishing API docs or changing public routes:
cd web
npm.cmd run validate:apithe validator checks route/spec drift and verifies the rendered reference still has examples plus auth/scope notes for every operation.
api reference
previous page
Owlette public API quickstart
This developer-preview quickstart creates a scoped API key, verifies it, lists your site inventory, queues a safe screenshot command on one machine, and polls the command result. It uses only the live REST API and common shell tools; no SDK publishing or external launch packaging is required.