Frequently Asked Questions

Use TopoKit Play at topokit.io/play — paste your JSON, click Generate Share Link, and you get a short URL anyone can open. No install, no sign-up, no SDK setup. The link works forever.

Yes. Iframe the /t/<hash> URL into any HTML page (Notion embed, Confluence iframe macro, MDX-rendered docs site, your own product UI) and the graph renders interactively in place. Append ?embed for a chrome-less view with no nav and no edit button — just the canvas. Pan, zoom, and search still work. Full snippets and the security model are documented at /docs/embedding.

Pass your license key on the iframe URL as #license=tk_... (recommended — fragments never reach our servers) or ?license=tk_... and the Unlicensed watermark is suppressed on your page. The SDK binds the license check to your parent page origin via window.location.ancestorOrigins or document.referrer — a leaked key only works on the domains it was minted for, so it is far less dangerous than a typical bearer token. Full details at /docs/embedding.

Yes. Every /t/<hash> URL has a matching /t/<hash>.png that returns a 1200×630 Open Graph image of the rendered graph, served with summary_large_image Twitter card meta. Paste a share link into any modern chat or social app and you get a rich preview of the actual topo. Build-pipeline consumers that need the real PNG inline (rather than the OG fallback returned on first hit) can append ?wait=1 — see /docs/ai-instructions for details.

Yes. POST your TopoKit JSON to https://topokit.io/api/topos, get back a short hash, share https://topokit.io/t/<hash>. A one-prompt template that points your agent at /docs/data-format and a live sample ships in the "Use with AI" panel on /play. Full API reference at /docs/data-format; agent prompt at /docs/ai-instructions.

That is exactly the workflow we built for. Tell any modern LLM "here's my raw data, convert it to TopoKit graph JSON and POST it to https://topokit.io/api/topos" and it hands you back a share URL. The full vision is documented at /use-cases/ai-agent-workflow.

TopoKit is a TypeScript-native graph visualization SDK with zero runtime dependencies. It renders interactive network graphs, organizational charts, dependency trees, and topology maps using a hardware-accelerated HTML5 canvas. It ships seven layout algorithms (force, hierarchical, dagre, circular, radial, concentric, grid), force-directed edge bundling, clustering, progressive expand, web-worker layout, and first-class React 18+ bindings.

TopoKit is a batteries-included graph SDK with one install: 7 layout algorithms, Canvas2D + LOD rendering up to 20K nodes, and the full UI kit (minimap, legend, badges, search, tooltip, context menu) — all in under 80 KB gzipped, with native TypeScript types. It works in vanilla JavaScript, Vue, Svelte, and Angular, plus first-class React 18+ bindings. The trade-off vs open-source alternatives is a commercial license for production use; in exchange you get vendor accountability, an SLA, and no maintenance debt across a stack of community packages.

The renderer-canvas package is under 80 KB gzipped. Layouts and components are tree-shakable, so a typical production app ships 90–140 KB total depending on which features you use.

TopoKit renders 20,000+ nodes at 60 fps on commodity hardware using level-of-detail (LOD) culling, spatial indexing, and an off-main-thread layout web worker. Try it yourself on the /showcases/stress-test page.

Yes. The core SDK is framework-agnostic and works in vanilla JavaScript, Vue, Svelte, and Angular by mounting onto a DOM element. There is also a first-class @topokit/react package with a <GraphCanvas> component and useGraph hook for React 18+ (including Next.js, Remix, and React Router).

Yes — the SDK is SSR-safe. It defers DOM access until the component mounts, so it works with Next.js App Router, Remix, SvelteKit, and Astro. Static export is also supported.

All modern evergreen browsers: Chrome, Edge, Firefox, Safari, and Opera (last two major versions). TopoKit uses Canvas2D and standard ES2020 APIs. Internet Explorer is not supported.

The graph engine, layout algorithms, and data-mapping APIs run in Node.js for use cases such as pre-computing layouts on a server, generating static graph snapshots, or building tooling. The canvas renderer requires a browser environment.

TopoKit is source-available under the Business Source License 1.1 (BSL 1.1). Each version is automatically relicensed under the Apache License 2.0 on the fourth anniversary of its public release. Read the full terms on /license.

You need a Pro or Enterprise license if you use TopoKit in a commercial product, in production, embedded in a SaaS, or in any way that generates revenue directly or indirectly. Non-production use, prototyping, internal evaluation (up to 90 days), and educational use are free.

Pro and Enterprise are licensed per developer (per seat). One license covers a single developer using the SDK on any number of applications, environments, or end-user deployments belonging to your organization.

You keep the right to use the version of TopoKit you had at expiry, indefinitely, in production (perpetual fallback license). You only lose access to new releases, updates, and support until you renew.

Pro is $1,499/year per developer. Enterprise is $1,999/year per developer (adds SSO, white-label, priority support and SLA, dedicated onboarding, custom integrations). Education is free for verified students and educators (2-month renewable license, 50-node limit, watermark). See /pricing for the full breakdown.

Yes. Volume discounts begin at 5+ seats. Larger organizations and registered non-profits should contact [email protected] for custom quotes.

Email [email protected] for billing options including invoicing, purchase orders, bank transfers, and procurement workflows.

Yes. If TopoKit does not work for your use case, contact [email protected] within 30 days of purchase for a full refund.

Pro customers get email support with a 2-business-day response target. Enterprise customers get priority support with a 1-business-day SLA, plus a dedicated onboarding session. Email [email protected] with your license key. Pre-sales questions can be sent to [email protected].

Licensed users can email [email protected] with bug reports, integration questions, and feature requests. Critical bugs are typically patched within one minor release.

Email [email protected]. We offer responsible-disclosure handling and respond within 72 hours. A PGP key is available on request.

No. The TopoKit SDK does not contain telemetry, analytics, error reporting, "phone-home" functionality, or remote license verification at runtime. Whatever graph data you visualize stays in your environment.

Our handling of personal data through the topokit.io site, license administration, and support communications follows GDPR, UK GDPR, KVKK, and CCPA requirements. See /privacy for the full policy. Because the SDK does not transmit any data to us, our processing is limited to the business relationship — not your end users.