Skip to main content
The webAI SDK is a single frozen bridge object that the webAI shell injects into every app’s window object. It exposes capability facades — each focused on one domain — covering AI, identity, collaboration, files, and the shell itself. Apps access it through window.apogeeSDK. When your app runs outside the shell (standalone browser preview, local file), the SDK is null — always guard before calling.
const sdk = window.apogeeSDK || null;
if (!sdk) return;
const identity = sdk.identity.getState();

Declaring what your app needs

Your app declares which facades it needs through a shell manifest. Only declared facades are injected at runtime.
<script id="apogee-shell-manifest" type="application/apogee-shell-manifest+json">
{
  "schemaVersion": 1,
  "name": "My App",
  "version": "1.0.0",
  "requires": {
    "managers": ["identity", "intelligence", "theme"]
  }
}
</script>
Place this in the <head> of your app’s HTML. After loading, check sdk.supportedFacades to see which facades are actually available — a facade may be omitted if the current shell build doesn’t ship it, or if the user is running the browser-only mode.

Full reference

The complete reference — every facade, every method, parameter tables, and live interactive examples — lives in the in-app Developer panel.

Open the Developer panel

  1. Open Settings → Experimental and toggle Developer Mode on.
  2. A terminal icon appears in the top right of the app. Click it to open the Developer panel.
  3. Go to the Documentation section. You’ll find three modes:
    • Docs — browse every facade and its methods.
    • Lab — call methods interactively against a live runtime.
    • Components — inspect design-system primitives your app can use.

Learn more

Build apps

Build your first app using the webAI SDK and platform facades.

App architecture

Understand how apps run inside the webAI shell.