API Reference
API Overview
The public SDK surface now covers scan, graph, execution, runtime events, extension points, speech, and lifecycle control.
Need the shortest path?
Use Quick Start when you want the smallest working route → scan → graph → run flow first.
Something feels off?
Inspect scan output, graph state, active route/context, and dispatch in a practical order.
Need the full surface?
Browse all runtime methods, hooks, extension points, and lifecycle APIs.
Most integrations should start with init, scan, graph, and run. Move to lower-level APIs only when you need more control, debugging, or explicit extension hooks.
The public API is still intentionally compact, but it now covers more than the earliest MVP. The runtime supports setup, scanning, graph inspection, execution, speech, extension points, runtime context injection, and runtime events.
Recommended learning order
Cinder.init
Set up the runtime with a local-first baseline and optional fallback settings.
Cinder.scan
Discover semantic structure in the DOM and refresh the runtime graph.
Cinder.graph
Inspect the scoped application graph, indexes, and runtime state used by local resolution.
Cinder.run
Use the full resolve → dispatch → reflex pipeline through one high-level method.
Cinder.resolve
Inspect the local intent selected for a command before dispatch happens.
Cinder.dispatch
Execute a resolved intent against the DOM, bindings, routes, or adapters.
Main API groups
Setup and lifecycle
Cinder.init()Cinder.configure()Cinder.status()Cinder.destroy()
Use these to bootstrap the runtime, change config, inspect lifecycle state, and tear the runtime down cleanly.
Scan, graph, and execution
Cinder.scan()Cinder.lastScan()Cinder.graph()Cinder.resolve()Cinder.dispatch()Cinder.feedback()Cinder.respond()Cinder.run()
This is the core browser runtime path.
Optional bindings and explicit handlers
Cinder.bind()Cinder.unbind()
Bindings are still useful, but they are not the core product promise. Standard DOM flows should work tag-only where normal browser behavior is enough.
Route, site-manifest, cold-graph, and DOM extension points
Cinder.registerRoute()Cinder.unregisterRoute()Cinder.getRoutes()Cinder.registerSiteManifest()Cinder.unregisterSiteManifest()Cinder.getSiteManifests()Cinder.registerColdGraph()Cinder.unregisterColdGraph()Cinder.getColdGraphs()Cinder.registerDomAdapter()Cinder.unregisterDomAdapter()Cinder.getDomAdapters()
Use these when:
- route activation is more complex than anchor/path metadata
- the app can describe whole-site semantic structure beyond the current DOM
- you want Cinder to derive cold graph structure from a higher-level site manifest
- app controls are custom and do not behave like standard inputs/buttons/forms
Intent and runtime-context extension points
Cinder.registerIntent()Cinder.unregisterIntent()Cinder.getIntents()Cinder.setContextProvider()Cinder.clearContextProvider()Cinder.getContext()
Use these when local resolution needs explicit application state or custom domain matching without hiding that logic inside the SDK core.
AI fallback core extension point
Cinder.setLlmCore()Cinder.resetLlmCore()
Swap the single installed llm-core slot that run() escalates to when local resolution is unknown or low-confidence - the default is the built-in HTTP core, but a custom core (a local embedding model, a chain of local-then-cloud cores, a different provider integration) can take that slot instead.
Runtime events and reflex hooks
Cinder.on()/Cinder.off()Cinder.onReflex()/Cinder.offReflex()
Runtime events are the main observability hook for scan, resolve, dispatch, fallback, and speech activity.
Speech and voice hooks
Cinder.say()Cinder.listen()Cinder.stopListening()Cinder.speechStatus()Cinder.onTranscript()/Cinder.offTranscript()Cinder.onSpeechError()/Cinder.offSpeechError()
Text commands still remain first-class even when speech is enabled.
What is documented deeply today
The current docs already cover the main first-run path well:
- Cinder.init
- Cinder.scan
- Cinder.graph
- Cinder.resolve
- Cinder.dispatch
- Cinder.run
- Cinder.bind
- Cinder.listen
What the runtime now also supports
The current SDK also includes route registry, DOM adapter, custom intent, runtime context, and runtime event APIs. Those are part of the real public surface and should be understood as first-class extension points, not hidden internal hooks.
Best next pages
Cinder.run
Start with the highest-level execution path before diving into lower-level methods.
Dispatch and Feedback
Understand how resolved intents become route navigation, DOM execution, and user-facing reflex output.
Debugging
Inspect scan output, graph state, resolution, dispatch, and fallback behavior in a practical order.
Continue reading
Previous: Auditing and Enrichment Tools
Three developer-run tools - auditUntaggedElements, auditLabelQuality, and exportGraphForEnrichment - for finding tagging gaps and improving graph labels offline, never at runtime.
Next: Cinder.init
Initialize the runtime with app, semantic, speech, and AI configuration.