API reference

The NLP engine exposes a primary public endpoint for querying: POST /api/analyze (along with standard health probes like /healthz and /readyz). It takes a prompt (plus optional schema metadata) and returns a structured Analysis object that tells a downstream query generator what the user is asking for. The engine deliberately stops short of emitting a final MongoDB pipeline — that step lives in the desktop sidecar, on the user's own machine, where their schema and data are.

If you're integrating the desktop app, you don't need this — the sidecar handles the round-trip. This page is for SDK / 3rd-party integrators and for understanding the on-the-wire contract.

Base URL

• Hosted: https://nlp-engine-prod.lunamic.co
• Self-hosted: whatever URL you mapped your nlp-engine container to.

Authentication

A bearer token in the Authorization header. Create one from the dashboard; it looks like iom_.... The portal owns verification, plan resolution, and quota accounting — the NLP engine itself is stateless.

Authorization: Bearer iom_8f4c9e1b...

The string X-Api-Key: iom_8f4c9e1b... is also accepted as an alias for clients that can't set Authorization cleanly.

Next steps

Explore the specific areas of the API:

• POST /api/analyze — Request/response schemas and code examples.
• Rate limits — Quotas and burst limits.
• Health & Versioning — Probes and client version contracts.