Xylolabs API Documentation

Welcome to the Xylolabs IoT platform documentation. This site covers the REST API, communication protocols, embedded platform guides, and deployment instructions.

Quick Links

Resource	Description
API Reference (EN)	Complete REST API documentation
API Reference (KO)	REST API 문서 (한국어)
Architecture	System architecture overview
Deployment Guide	Production deployment instructions
SDK Guide	Embedded SDK integration guide

Domains

Domain	Purpose
api.xylolabs.com	REST API endpoints (/api/*)
admin.api.xylolabs.com	Admin dashboard (web UI)
docs.api.xylolabs.com	This documentation site

Protocols

• XAP Specification -- Xylolabs Audio Protocol for device-to-server audio upload
• XMBP Specification -- Xylolabs Metadata Binary Protocol for real-time sensor streaming

Platforms

Guides for supported embedded targets:

• Raspberry Pi Pico (RP2040)
• RP2350 Feasibility
• ESP32
• STM32
• nRF

Authentication

The API supports two authentication methods:

• JWT Bearer Token -- For dashboard users. Obtain via POST /api/auth/login.
• API Key -- For embedded devices. Use header X-Api-Key: xk_....

See the API Reference for details.