Developer documentation

Lifecycle and continuity

Installation lifetime, viewer sessions, browser interaction and published revisions.

Mount and remove

  1. Load the generated browser script before using window.RapidEye.
  2. Create a container and mount the published experience.
  3. Subscribe immediately to the events your application needs.
  4. Treat ready as setup completion and test actual playback separately.
  5. Unsubscribe and call destroy when an application route removes a programmatic instance.

Auto-mounted data attributes are scanned after document setup and when nodes are added. Add the experience attribute before inserting a container. Attribute changes alone do not remount an existing instance.

The custom element mounts when connected and destroys its controller when disconnected. Changing its experience-id attribute does not update an existing controller; recreate the element for a new experience.

Viewer continuity

The hosted runtime manages a 15-minute viewer access token and a rotating refresh credential valid for 24 hours. Your host page does not need to read or refresh them.

The same viewer session can retain its conversation and restore an active task after reload or token renewal. Earlier chat messages are not restored in the UI after reload.

The runtime uses memory and iframe session storage rather than third-party cookies. Storage blocking, clearing storage or closing the tab can lose guest continuity.

A task waiting for a viewer reply expires after 30 minutes and can then only be stopped. A new viewer session does not restore another viewer session’s task.

Browser interaction

Enable Chat and Browser agent, publish, and confirm that the owner has browser capacity. The viewer requests a task in Chat and confirms when prompted.

Use bounded read-only research. A task can ask a question, wait for a reply and continue to a useful answer. The viewer replies inside Chat and uses Stop to end it.

For a task locked to an explicit page, interaction stays on that page’s origin and permits reading rather than arbitrary navigation or transactions.

Viewer browser sessions have no saved signed-in profile. Private browser sign-in, credentials, payment details and checkout are outside the current distribution scope.

Publish, update and revoke

A publication creates an immutable configuration revision. Draft edits do not affect the live experience until publication. The snippet keeps its experience identifier.

Current published capabilities and limits govern existing sessions after the cache window. Reload the host page to pick up the new presentation.

Labels, detections and transformation assets are read live rather than pinned into the configuration revision. Their edits do not require an embed configuration publication.

Revoke disables new access and ends authorized operations after rechecks. It does not remove bytes already loaded by a browser or erase the stored draft.

PathImplementation expectation
New chat turnUp to approximately 30 seconds, plus lookup time.
Idle browser streamApproximately 60 seconds, plus lookup time.
Active browser taskApproximately 45 seconds; one failed recheck can add 15 seconds, plus lookup and browser cleanup time.

These are cache/timer expectations, not measured service guarantees for every device or cleanup path. Verify revocation on your actual installation.