Developer documentation
Configure and publish
Owner controls, capabilities, real configuration fields and publication behavior.
Owner workflow
Create embed makes a draft for the selected video. Title is an internal label. Branding Display title is the title shown to viewers.
Save draft stores configuration without changing the live revision. Publish embed changes saves current edits and creates a new published revision after confirmation.
Revoke disables the experience while retaining its draft and revision history. Publish embed can publish it again. The experience identifier and copied snippet remain the same.
Allowed domains
Enter hostnames, not URLs. Add the bare domain and www hostname separately if both serve your page. Up to 50 entries are accepted.
| Entry | Meaning |
|---|---|
| partner.example | Matches that HTTPS hostname. |
| www.partner.example | Matches the www hostname separately. |
| *.partner.example | Matches nested subdomains, not the bare domain. |
| localhost:4173 | Local testing on that exact host and port, including HTTP. |
| 127.0.0.1:4173 | A separate local hostname; add it if you use it. |
An optional port must match the page origin. Standard HTTPS is normalized without :443, so enter the hostname alone. HTTP is supported for localhost and 127.0.0.1 only.
Capabilities
| CMS label | Configuration key | Default | Effect |
|---|---|---|---|
| Chat | chat | On | Text questions about the experience video. |
| Voice | voice | Off | Microphone capture, spoken replies and audio replay. Requires a secure context and microphone delegation. |
| Detections | detections | On | Available detected-object overlays. |
| Transformations | transformations | On | Available visual transformations, including processed recolor variants. |
| Featured items | featured_items | On | The featured items rail when the video has available items. |
| Browser agent | agent | Off | Opt-in browser tasks requested through Chat. Uses separate browser capacity and daily limits. |
Browser tasks require both Chat and Browser agent in the published revision. The publishing panel records the required policy opt-in automatically.
Available overlays, featured items and transformation clips depend on the video data. Enabling a capability does not create missing processed assets.
Branding and compatible fields
| Field | Accepted value | Current effect |
|---|---|---|
| branding.title | Up to 80 characters; empty by default. | Visible display title. |
| branding.accent_color | Six-digit hexadecimal color, such as #e73c0e. | Visible accent color. |
| branding.theme | dark or light; dark by default. | Stored by the editor, but does not change the current player presentation. |
| branding.logo_url | HTTPS URL or null; null by default. | Stored compatibility field, not rendered; no logo control in the current editor. |
Loader theme options and host:theme also have no current visual effect. Use the published title and accent controls for supported branding.
Configuration limits
| CMS label | Configuration key | Default | Accepted range |
|---|---|---|---|
| Turns per visitor per day | turns_per_visitor_per_day | 40 | 1 to 100,000 |
| Turns per experience per day | turns_per_experience_per_day | 2,000 | 1 to 10,000,000 |
| Visitors per IP per hour | visitors_per_ip_per_hour | 20 | 1 to 100,000 |
| Browser tasks per visitor per day | agent_runs_per_visitor_per_day | 3 | 1 to 100 |
| Browser tasks per experience per day | agent_runs_per_experience_per_day | 50 | 1 to 100,000 |
The references above derive from the same defaults and bounds as the publishing validator. These values are configuration defaults, not a price or commercial agreement.