API Reference
This page collects all APIs the paiOS engine exposes. Use it to find the right interface for your use case (local IPC, remote control, or tool integration).
Available APIs
Section titled “Available APIs”| API | Transport | Use case | Reference |
|---|---|---|---|
| gRPC API | UDS (local) or TCP/TLS (remote) | Primary interface: lifecycle, config, status, inference. Type-safe Protocol Buffers. | gRPC API Reference: services and messages |
| REST API | HTTP | Ollama and OpenAI client compatibility (convenience). | API domain: gateway and routing |
| MCP Server | SSE / stdio | Host PC integration (Claude Desktop, OpenClaw, Cursor). Engine exposes tools and sensors. | API domain: MCP Server adapter; C4 Architecture: system context |
For architecture (routing matrix, port isolation, security), see the API domain (api) and Security.
Quick links
Section titled “Quick links”- gRPC API Reference: gRPC service definitions (EngineService, messages, RPC methods). Generated from
api/grpc/*.proto. - Rust API (Internal): Internal engine crates (for contributors). Module overviews and types.
- Rust API (Standard rustdoc): Full rustdoc HTML (external).
Coming soon
Section titled “Coming soon”- REST endpoint reference (OpenAI/Ollama compatibility)
- Hardware specifications and pinouts
- CLI reference (if applicable)