Nodaro Docs
DocumentationNode ReferenceModelsAI Agents (MCP)DevelopersSelf-hostingResearch
Embeds

Embeds

The two ways to put Nodaro inside your own product, a MiniApp that runs a published workflow and the stateless 3D scene viewport, and when to use each one.

View as MarkdownOpen in ChatGPTOpen in Claude

Embeds put part of Nodaro inside your own product. There are two, and they solve different problems. The MiniApp embed runs a published workflow for your users, and the 3D scene viewport shows, and optionally edits, a 3D scene without running anything.

Choose an embed

MiniApp3D scene viewport
What it doesRuns a published MiniApp: collects the inputs, starts a run and shows the result.Draws a 3D scene plan: the viewport, playback, the object list, pose editors and the revision history.
How you embed itYour own interface on the REST API, or a frame from the MiniApp's embed code.A frame at /embed/scene3d, driven by postMessage.
AuthenticationYour own interface uses a personal API token or an OAuth token, kept on your server. The frame acts with the viewer's own Nodaro session.None. The frame has no session and makes no network call.
CreditsEvery run costs credits, paid by the account the run acts as.Never. The viewer runs no job.
Where the state livesRuns are stored in Nodaro.Your page keeps the scene. The frame keeps nothing across a reload.

When to embed a MiniApp

  • You published a workflow as a MiniApp, and your users should run it from your site or your app. See Apps.
  • You want your own form and your own styling around the app. Build them on the REST API.
  • You want the quickest route. Paste the MiniApp's embed code into your page.

Read Embed a MiniApp.

When to embed the 3D scene viewport

  • Your product stores 3D scene plans, from Generate 3D Scene and Edit 3D Scene jobs, and your users should see them.
  • Your users should play, scrub and select objects in a scene, read-only by default.
  • Your users should edit poses, colors and locks, and your page saves each new revision.

Read Embed the 3D scene viewport, and 3D scene format for the data the viewport draws.

Both keep tokens out of the browser

Neither embed puts a Nodaro token in your web page. When you build your own MiniApp interface, the token stays on your server. The 3D scene viewport never carries a token in its messages: your page fetches the scene's assets with its own session and sends the bytes.

Frequently asked questions

Embed a MiniApp

Run a published Nodaro MiniApp in your product with its embed code, or with your own form on the REST API, from reading its inputs to runs, results and errors.

Embed the 3D scene viewport

Frame Nodaro's 3D scene viewport in your app and drive it with postMessage, from the handshake and state messages to edit events, asset transport and limits.

3D scene format

How a Nodaro 3D scene plan is built, from version 1 primitives and keyframes to version 2 GLB assets, semantic entities, camera tracks, shots and edit overlays.

Apps (MiniApps)

A MiniApp is a workflow published as a simple form with its own URL. Choose the inputs people fill in, the view modes, sharing, pricing and embedding.

Last updated on

Picker catalogs

Build Nodaro's pickers in your own app with @nodaro/prompts, turn selections into prompt clauses, translate labels, show pictures or read catalogs over the API.

Embed a MiniApp

Run a published Nodaro MiniApp in your product with its embed code, or with your own form on the REST API, from reading its inputs to runs, results and errors.

On this page

Choose an embed
When to embed a MiniApp
When to embed the 3D scene viewport
Both keep tokens out of the browser