←back to docs

Blueprint Embed Preview

Embed a live, read-only blueprint canvas diagram into any webpage or application using a simple iframe.

The Blueprint Embed Preview is designed to be dropped into an <iframe>. It renders a full-screen, read-only blueprint canvas — the same visual diagram you see inside the platform — powered entirely by a URL. No login, no integration code, just a URL with the blueprint data encoded in it.

Embedding with an iframe

Construct the URL by taking the base path and appending the blueprint JSON as the blueprint query parameter. Then point an iframe at it:

The canvas fills the entire iframe and is interactive — visitors can pan and zoom to explore the blueprint — but cannot make any changes.

URL Parameters

  • blueprint (required) — The blueprint to render, as a URL-encoded JSON or YAML string.
  • controls (optional) — Set to false to hide the pan/zoom controls. Useful for tighter embed layouts where you want a cleaner look.

Common Use Cases

Documentation and guides: Embed live blueprint diagrams directly in docs, tutorials, or blog posts so readers can see exactly how an agent is structured.

Shareable previews: Send a URL to a teammate or customer that opens a visual snapshot of a blueprint — no platform access needed on their end.

Builder tools and integrations: Any tool that generates or modifies blueprints can render an instant visual preview by pointing an iframe at this URL.

blueprintembediframepreviewcanvasvisual