Skip to main content
Version: 0.0.41

Lakehousecat API

Lakehousecat exposes its functionality through a set of HTTP APIs. This reference documents the supported public API surface — the use cases and endpoints recommended for external integration.

Scope of this documentation

Only the workflows described in this section are part of the supported public API. The full internal API surface is larger but is not documented here, as it requires knowledge of internal sequencing and state management that is not exposed publicly.

Authentication​

All API endpoints require a Bearer token. Use an API key for integrations — it does not expire with your browser session.

Generate your API key in the Lakehousecat UI:

Account Settings → Security → API Keys → Generate API Key

Copy the key and store it securely. Include it in every request:

Authorization: Bearer <your-api-key>
export LHC_TOKEN="<your-api-key>"

Services and Base URLs​

Lakehousecat runs as multiple independent services. Each service has its own base URL and port.

ServiceAPI PrefixDefault Port
LHC Core API/api/v1/lhc42021
LLM API/api/v1/llm42020
Analytics API/api/v1/analytics42019
Semantic API/api/v1/semantic42118

For a local evaluation setup, services are available at http://localhost:<port>. For production Kubernetes deployments, your administrator provides the external hostname.

API Documentation Availability​

The interactive API documentation (Swagger UI) is available in development environments only:

http://localhost:<port>/api/v1/<service>/docs

It is disabled in production deployments. External integrations should use the use-case guides below.

Use Cases​

The following use cases are supported and documented for external integration:

#Use CaseDescription
1Authentication & SetupGenerate and use API keys, verify connectivity
2Chat with DataSend analytical questions, receive answers and chart references
3Create a Custom ModelCombine a provider model with datasources via API
4Retrieve ChartsList and fetch generated charts programmatically
5Manage DatasourcesCreate, validate, and trigger semantic extraction
6Manage Users & GroupsProvision users and control group membership

Health Check​

Each service exposes a /health endpoint:

curl http://localhost:42021/health   # LHC Core
curl http://localhost:42020/health # LLM
curl http://localhost:42019/health # Analytics
curl http://localhost:42118/health # Semantic