Skip to content

Getting Started

The Service is reachable via the following URL:


But in order to use the service, you need to create a setup file.

Don't worry, this is not as complicated as it sounds. The file is a simple JSON file with some configuration options.

After you have created the setup file, you must host this file in a public location, such as a Gist GitHub or JSON Blob, and provide the URL as an url parameter setup to the service like this:


And you are done! The rooomAssistant service will load the configuration file and present the scene to you.

But where do i define the scene, logic and interactions? This is done in the same file or if you want to have more control, you can embed it as an iframe and use the API. Here you have more control over the scene and interactions. Which approach you choose depends on your use case.

Use the setup file...

... if you know all content ahead of time, you can use the setup file to define the scene, logic and interactions that describes the different states of the scene. Each state consists of text presented in a speech bubble, buttons that the user can click, and actions triggered when the user enters the state. These interactions may trigger other actions such as character animations, changes to the camera position, or showing/hiding objects in the scene.

Use the Api...

... if you want more fine-grained control over the interaction with the scene. In this approach, scripting the states is optional and can be omitted. Instead, the interactions with the scene are controlled programmatically using the API, allowing for more flexibility in how the user interacts with the scene.

Overall, both approaches offer a high degree of control over the rooomAssistant experience and allow for the creation of immersive and engaging scenes that guide users through websites or apps.


We are planning the creation of the rooomAssistant experience using a visual editor. This approach is currently in development and will be released in the future.