API reference
Interactive references for every Loams API, with the status of each.
Each reference below is rendered by Scalar from an OpenAPI description that lives in this site's public/openapi/ folder. Every operation carries a badge: Available (implemented in the engine), In progress (implementation or integration incomplete) or Planned (designed, nothing runs yet).
| API | Protocol | Status | Reference |
|---|---|---|---|
| Native Connect | Connect / gRPC / gRPC-Web, port 8080 | 18 namespace, collection, document and hybrid Search RPCs | Open · OpenAPI |
| Native REST | REST, port 8080 | Available; operations and import in progress | Open · OpenAPI |
| Qdrant-compatible | REST 6333, gRPC 6334 | Available | Open · OpenAPI |
| Elasticsearch-compatible | REST, port 9200 | Implemented subset | Open · OpenAPI |
| Loams Live | Connect / gRPC, dedicated loopback port 7710 | In the default build; embedded store or TiKV (live-tikv) | Open · OpenAPI |
| Loams Durable | Resonate protocol, port 8001 | Implemented with SQLite behind the durable feature; the TiKV store is in progress | Open · OpenAPI |
| Loams Jobs | Connect / gRPC | Planned (design only) | Open · OpenAPI |
The Loams Live reference follows the loams.live.v1 protobuf and shows the Connect JSON mapping. The native Connect reference at /api-reference/connect is derived from proto/loams/{instance,collection,live,errors}/v1, including 18 implemented namespace, collection, document and hybrid Search RPCs. The original schemas use protoc-gen-connect-openapi; newer collection/query entries are source-derived snapshots checked against handlers. Check operation badges and the selected engine ref.
Not covered here
- Arrow Flight SQL (port 8082) is gRPC and Arrow, not HTTP JSON. Use any ADBC or Flight SQL driver. It supports read-only statements, the catalog commands and
DoPutingest. - Loams Graph (
loams.graph.v1) is served on the native port when the engine is built with thegraphfeature; otherwise its RPCs answerfeature_not_in_variant. - Loams House (
loams.house.v1) is proxied by the native port to aloams-fabricHouse front named by--house-endpoint; without one it answershouse_not_configured. - Plugin MCP is implemented as stdio tooling in the separate plugin workspace; desktop MCP components also exist. The engine-native retrieval MCP server and analytics convenience helpers remain planned.
- Postgres and MySQL wire reads are implemented behind optional
pgwireandmysql-wirefeatures. These listeners query collections; they are distinct from full bucket-backed OLTP. MySQL supports text SELECT and rejects writes/prepared statements.
Authentication is off by default, and the engine then serves loopback only. Set LOAMS_AUTH_MODE to apikey, oidc or tailscale to admit other clients; see the CLI guide. The HTTP API guide walks through the stream, CloudEvents and link endpoints with examples.