Monstral / API Reference

API Reference

A small, project-scoped surface for crawling, embedding, and reading back what visitors did.

travel_explore

Crawl & Analyze

Kick off discovery on a project, then turn the result into a scored, reviewable understanding document.

widgets

Embed & Chat

Serve the live tour and hotspot config, and answer a visitor in context β€” scoped to that project's approved document.

insights

Telemetry & Leads

Record visitor behavior with a de-duplicating sequence number, and report a captured lead the moment intent crosses your threshold.

query_stats

Insights & Usage

Read back aggregated funnel and drop-off data, plus token and cost consumption, per project.

auth β€” two ways in
# Human session (browser, httpOnly cookie)
$ curl --cookie "monstral_session=..." ...
# Machine / CI (service key)
$ curl -H "Authorization: Bearer sk_live_..." ...