Documentation Portal

Run the first explicit developer quickstart.

This quickstart follows the current repository shape: start the bridge, connect one runtime with an explicit session id, then call discovery or execution routes with the correct auth lane.

Documentation map

The docs portal stays in the same application as the product shell so setup, deployment, connector, and developer guidance can evolve with the codebase.

In-repo docs7 foundation routes5 developer routesCurrent: Developer Quickstart

Foundation docs

  • OverviewRoute

    Start with the current architecture, product surfaces, and the stable documentation sections.

  • Getting StartedRoute

    Install the workspace, configure local env files, and run the first verification flow.

  • DeploymentRoute

    Use the managed bridge deployment order, health checks, migrations, and workspace bootstrap flow.

  • ConnectorsRoute

    Understand the Figma reference connector, Satellite runtime, and explicit session routing model.

  • SecurityRoute

    Review auth lanes, workspace isolation, policy controls, rate limiting, and audit semantics.

  • API ReferenceRoute

    Browse the stable HTTP route groups, shared envelopes, auth lanes, and machine-readable errors.

  • TroubleshootingRoute

    Use the current operational failure patterns for readiness, auth, session liveness, policy, and MCP issues.

Developer docs

  • DevelopersRoute

    Developer-facing entry point for HTTP, MCP, connector, and shared-contract guidance.

  • Developer QuickstartOpen

    Bring up the bridge, connect one runtime, and make the first explicit authenticated calls.

  • HTTP GuideRoute

    Use the bridge HTTP transport with the correct auth lane, shared envelopes, and explicit targetSessionId routing.

  • MCP GuideRoute

    Use the Streamable HTTP MCP endpoint, LIST_CAPABILITIES, and the same connector-neutral tool catalog.

  • Connector ModelRoute

    Understand connector definitions, capability metadata, data scopes, and high-risk policy presets.

Step 1: Start the platform locally

Bring the workspace up with the current env contracts before trying any connector or HTTP flow.

  1. Install dependencies with npm install.
  2. Configure bridge and web env files from their checked-in examples.
  3. Run npm run dev or targeted workspace dev commands when you only need one app.

Step 2: Connect one runtime explicitly

Use a known connector family and a chosen session id before attempting any bridge call that depends on a live runtime.

Figma pluginSatellite runtimeExplicit sessionId required

Connect either the Figma plugin or the Satellite runtime with one explicit sessionId. Confirm the result through GET /api/v1/sessions/:sessionId before treating the runtime as a valid target.

Step 3: Choose the correct auth lane

The bridge keeps human account bootstrap, automation, and runtime auth separate.

Use a Supabase user bearer token for GET /api/v1/account/session and secure product-shell reads.

Use an API key for agent and automation paths such as GET /api/v1/tools, GET /api/v1/capabilities, and POST /api/v1/tools/execute.

Include x-uab-workspace-id on workspace-scoped reads and writes when the route requires explicit workspace targeting.

Step 4: Call the first routes

These are the current stable bridge-facing starting points.

/healthz/readyz/api/v1/capabilities/api/v1/sessions/api/v1/tools/execute
  • Use GET /healthz and GET /readyz to confirm the bridge is alive and dependencies are reachable.
  • Use GET /api/v1/capabilities and GET /api/v1/connectors to load the shared discovery catalog.
  • Use GET /api/v1/sessions or GET /api/v1/sessions/:sessionId to confirm the runtime and read-state before any execution attempt.
  • Use POST /api/v1/tools/execute only with one explicit target session and a capability that belongs to the connected connector family.