RapidEyeDeveloper docs
Live demo
Docs EmbeddingEmbed a RapidEye experience

Quickstart

Embed a RapidEye experience

Publish a video experience and install the generated snippet on your website.

Before you start

A RapidEye experience presents one video, its enabled visual features and its chat surface inside a hosted iframe. Your website loads the small version-one browser wrapper.

  • Have a processed video in your RapidEye account and permission to publish it.
  • Use an HTTPS website where you can execute JavaScript and allow an external iframe.
  • Choose the exact hostnames for development, preview and production.
  • Start with Public access, Chat enabled, Voice disabled and Browser agent disabled.

Create and publish

  1. Open your video in RapidEye and choose Publish.
  2. Open Embed on your website and choose Create embed.
  3. Enter an internal Title and add Allowed domains, one hostname per line.
  4. Select Public under Access and set the visible Display title and Accent color.
  5. Choose Capabilities and Limits for this installation.
  6. Choose Publish embed, then Confirm.
  7. Check Published, revision and choose Copy snippet.

The owner uses the authenticated RapidEye publishing panel. There is no customer API-key provisioning flow or separately shipped package SDK.

Configuration and publishing reference

Install the copied snippet

Paste both copied lines into a custom HTML block or page template. Use the full snippet from the intended environment.

Production-origin structure 
<div data-rapideye-experience="EXPERIENCE_ID"></div>
<script async src="https://www.rapideye.ai/embed/v1.js"></script>

The generated snippet chooses the correct loader origin. A page builder must retain and execute the script. Do not substitute an unprovisioned embed hostname.

Framework and deployment examples

Verify on your website

  1. Open the page in a fresh browser session without signing into RapidEye.
  2. Start playback inside the iframe and confirm that the video advances.
  3. Open Chat and confirm that a video question receives a visible answer.
  4. Check the player, chat scrolling and keyboard on your supported devices.
  5. If Browser agent is enabled, verify a bounded read-only task and any requested reply.
  6. Test the actual production hostname and any preview hostname you plan to use.

A mounted iframe, ready event or browser preview does not establish successful playback or task completion. Validate the result the viewer needs.

Common installation problems