API reference
Interactive references for every Loam 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 (on the engine's main branch), In progress (built and landing) or Planned (designed, nothing runs yet).
| API | Protocol | Status | Reference |
|---|---|---|---|
| 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 | In progress | Open · OpenAPI |
| Loam Live | Connect / gRPC, port 7710 | In progress | Open · OpenAPI |
| Loam Durable | Resonate protocol, port 8001 | In progress | Open · OpenAPI |
| Loam Jobs | Connect / gRPC | Planned (design only) | Open · OpenAPI |
The Loam Live reference is generated from the loam.live.v1 protobuf with protoc-gen-connect-openapi and shows the Connect JSON mapping. The others are written by hand from the engine's routes.
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. - MCP (Streamable HTTP at
/mcp) is in progress. Its tools arelist_collections,get_documents,search,sqlandmemory_write. - The Postgres wire protocol is planned.
The engine has no authentication yet and binds to loopback by default. The HTTP API guide walks through the stream endpoints with examples.