or top navbar), so we match by href pattern anywhere on the // page and mark the link plus its enclosing

. The CSS rule is scoped // to [data-simplified="true"], so marking links in body content is safe — // they only hide for Open platform users. function markGlobalAnchors() { var anchorHrefs = [ 'docs.poly.ai/home', 'polyaijupiter-uki8686.slack.com', 'poly.ai/resources' ]; document.querySelectorAll('a[href]').forEach(function (a) { var href = a.getAttribute('href') || ''; var match = anchorHrefs.some(function (frag) { return href.indexOf(frag) !== -1; }); if (!match) return; a.dataset.openPlatformHidden = 'true'; var li = a.closest('li'); if (li) li.dataset.openPlatformHidden = 'true'; }); } // Mark top-nav tab links (Developer, API reference) for hiding. function markNavbarTabs() { document.querySelectorAll('a[class*="nav-tabs-item"]').forEach(function (a) { var text = a.textContent.trim(); if (HIDDEN_TABS.indexOf(text) !== -1) { a.dataset.simplifiedHide = 'true'; } else { delete a.dataset.simplifiedHide; } }); } // Inject a sticky upsell banner at the top of an enterprise page when the // user is in Open platform mode. Sets data-on-enterprise-page on so the // stylesheet can gray out and disable pointer events on everything in the // main content area except the banner itself. Idempotent — won't double- // insert across SPA navs. function applyEnterpriseBanner() { var existing = document.getElementById('free-trial-enterprise-banner'); var simplified = document.documentElement.dataset.simplified === 'true'; var enterprise = isEnterprisePath(window.location.pathname); if (!simplified || !enterprise) { if (existing) existing.remove(); document.documentElement.removeAttribute('data-on-enterprise-page'); return; } if (existing) return; document.documentElement.setAttribute('data-on-enterprise-page', 'true'); var banner = document.createElement('aside'); banner.id = 'free-trial-enterprise-banner'; banner.className = 'free-trial-enterprise-banner'; banner.setAttribute('role', 'note'); banner.innerHTML = '' + '' + '

' + '

Enterprise feature

' + '

This page is here for reference, but it isn\'t part of the Agent Builder free trial. When you\'re ready to use it, talk to sales about an enterprise plan.

' + '

' + 'Talk to sales' + '' + '

' + '

'; // Insert at top of main content. Mintlify uses #content-area / main; fall // back to body if neither exists yet. The CSS pins the banner to the top // of its scroll container with position: sticky. var mount = document.querySelector('main') || document.querySelector('#content-area') || document.body; if (mount && mount.firstChild) { mount.insertBefore(banner, mount.firstChild); } else if (mount) { mount.appendChild(banner); } var exitBtn = banner.querySelector('#free-trial-enterprise-banner-exit'); if (exitBtn) { exitBtn.addEventListener('click', function (e) { if (banner.dataset.dragSuppressClick === '1') { banner.dataset.dragSuppressClick = ''; e.preventDefault(); e.stopPropagation(); return; } e.preventDefault(); setSimplified(false); document.querySelectorAll('.simplify-toggle').forEach(function (b) { updateButton(b, false); }); markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); applyDeveloperContent(); applyEnterpriseBanner(); applyOpenPlatformOnlyBanner(); updateLandingPageStatus(); }); } applyStoredBannerPosition(banner); makeBannerDraggable(banner); } // Inject a sticky banner at the top of an Open-platform-only page when the // user is NOT in Open platform mode (the enterprise default). Mirrors // applyEnterpriseBanner but in the opposite direction. Sets // data-on-open-platform-only on so the stylesheet can gray out the // page body while keeping the banner readable. function applyOpenPlatformOnlyBanner() { var existing = document.getElementById('open-platform-only-banner'); var simplified = document.documentElement.dataset.simplified === 'true'; var opOnly = isOpenPlatformOnlyPath(window.location.pathname); if (simplified || !opOnly) { if (existing) existing.remove(); document.documentElement.removeAttribute('data-on-open-platform-only'); return; } if (existing) return; document.documentElement.setAttribute('data-on-open-platform-only', 'true'); var banner = document.createElement('aside'); banner.id = 'open-platform-only-banner'; banner.className = 'free-trial-enterprise-banner open-platform-only-banner'; banner.setAttribute('role', 'note'); banner.innerHTML = '' + '' + '

' + '

Agent Builder feature

' + '

This is part of PolyAI Agent Builder — the self-serve, 60-day free trial of Agent Studio. Switch on Free trial mode to read these docs in context, or talk to sales about getting it on enterprise.

' + '

' + '' + 'Talk to sales' + '

' + '

'; var mount = document.querySelector('main') || document.querySelector('#content-area') || document.body; if (mount && mount.firstChild) { mount.insertBefore(banner, mount.firstChild); } else if (mount) { mount.appendChild(banner); } var enterBtn = banner.querySelector('#open-platform-only-banner-enter'); if (enterBtn) { enterBtn.addEventListener('click', function (e) { if (banner.dataset.dragSuppressClick === '1') { banner.dataset.dragSuppressClick = ''; e.preventDefault(); e.stopPropagation(); return; } e.preventDefault(); setSimplified(true); document.querySelectorAll('.simplify-toggle').forEach(function (b) { updateButton(b, true); }); markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); applyDeveloperContent(); applyEnterpriseBanner(); applyOpenPlatformOnlyBanner(); updateLandingPageStatus(); }); } applyStoredBannerPosition(banner); makeBannerDraggable(banner); } // Wrap .developer-only sections in a

accordion in Open platform mode. // Unwrap them in full-docs mode. function applyDeveloperContent() { var simplified = document.documentElement.dataset.simplified === 'true'; if (simplified) { document.querySelectorAll('.developer-only:not([data-accordion-wrapped])').forEach(function (div) { var heading = div.querySelector('h2, h3'); var title = heading ? heading.textContent.trim() : 'Developer details'; var details = document.createElement('details'); details.className = 'dev-accordion'; var summary = document.createElement('summary'); summary.className = 'dev-accordion-summary'; summary.textContent = title; div.dataset.accordionWrapped = 'true'; div.parentNode.insertBefore(details, div); details.appendChild(summary); details.appendChild(div); }); } else { // Unwrap accordions back to plain divs document.querySelectorAll('.dev-accordion').forEach(function (details) { var div = details.querySelector('.developer-only'); if (div) { delete div.dataset.accordionWrapped; details.parentNode.insertBefore(div, details); details.remove(); } }); } } function createToggleButton() { var btn = document.createElement('button'); btn.className = 'simplify-toggle'; btn.type = 'button'; updateButton(btn, isSimplified()); btn.addEventListener('click', function (e) { // Drag-just-ended clicks are suppressed by makeDraggable (which sets // suppressNextClick). Guard here too in case other code fires a click. if (btn.dataset.dragSuppressClick === '1') { btn.dataset.dragSuppressClick = ''; e.preventDefault(); e.stopPropagation(); return; } var next = document.documentElement.dataset.simplified !== 'true'; setSimplified(next); // Sync all toggle buttons on the page. document.querySelectorAll('.simplify-toggle').forEach(function (b) { updateButton(b, next); }); markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); applyDeveloperContent(); applyEnterpriseBanner(); applyOpenPlatformOnlyBanner(); updateLandingPageStatus(); }); makeDraggable(btn); return btn; } // ── Drag support ────────────────────────────────────────────────────────── // The pill lives at a fixed top-right position by default. Users can drag // it anywhere in the viewport; the position is stored in localStorage and // restored on reload. A small movement threshold ensures a plain click still // toggles Open platform mode without being swallowed by the drag handler. function readStoredPosition() { try { var raw = window.localStorage.getItem(POSITION_KEY); if (!raw) return null; var parsed = JSON.parse(raw); if (typeof parsed.left !== 'number' || typeof parsed.top !== 'number') return null; return parsed; } catch (e) { return null; } } function writeStoredPosition(pos) { try { window.localStorage.setItem(POSITION_KEY, JSON.stringify(pos)); } catch (e) {} } function clampPosition(left, top, width, height) { var maxLeft = Math.max(0, window.innerWidth - width); var maxTop = Math.max(0, window.innerHeight - height); return { left: Math.min(Math.max(0, left), maxLeft), top: Math.min(Math.max(0, top), maxTop) }; } function applyStoredPosition(btn) { var pos = readStoredPosition(); if (!pos) return; var rect = btn.getBoundingClientRect(); var clamped = clampPosition(pos.left, pos.top, rect.width || 160, rect.height || 36); btn.style.left = clamped.left + 'px'; btn.style.top = clamped.top + 'px'; btn.style.right = 'auto'; btn.style.bottom = 'auto'; } function makeDraggable(btn) { var startX = 0, startY = 0; var originLeft = 0, originTop = 0; var dragging = false; var pointerId = null; btn.addEventListener('pointerdown', function (e) { // Only left-button / primary touch if (e.button !== undefined && e.button !== 0) return; var rect = btn.getBoundingClientRect(); startX = e.clientX; startY = e.clientY; originLeft = rect.left; originTop = rect.top; pointerId = e.pointerId; dragging = false; }); btn.addEventListener('pointermove', function (e) { if (pointerId === null || e.pointerId !== pointerId) return; var dx = e.clientX - startX; var dy = e.clientY - startY; if (!dragging && Math.abs(dx) < DRAG_THRESHOLD && Math.abs(dy) < DRAG_THRESHOLD) return; if (!dragging) { dragging = true; btn.classList.add('simplify-toggle--dragging'); try { btn.setPointerCapture(pointerId); } catch (err) {} } var rect = btn.getBoundingClientRect(); var next = clampPosition(originLeft + dx, originTop + dy, rect.width, rect.height); btn.style.left = next.left + 'px'; btn.style.top = next.top + 'px'; btn.style.right = 'auto'; btn.style.bottom = 'auto'; e.preventDefault(); }); function endDrag(e) { if (pointerId === null) return; if (e && e.pointerId !== pointerId) return; try { btn.releasePointerCapture(pointerId); } catch (err) {} pointerId = null; if (dragging) { btn.classList.remove('simplify-toggle--dragging'); var rect = btn.getBoundingClientRect(); writeStoredPosition({ left: rect.left, top: rect.top }); // Swallow the click event that follows pointerup after a drag so the // mode doesn't toggle when the user just repositioned the pill. btn.dataset.dragSuppressClick = '1'; setTimeout(function () { btn.dataset.dragSuppressClick = ''; }, 0); } dragging = false; } btn.addEventListener('pointerup', endDrag); btn.addEventListener('pointercancel', endDrag); } // ── Banner drag support ───────────────────────────────────────────────── // The lock banner uses the same drag mechanism as the pill but with its own // localStorage key and a wider clamp footprint. Defaults to a centered-top // position (set in CSS); after the first drag the explicit left/top win. function readStoredBannerPosition() { try { var raw = window.localStorage.getItem(BANNER_POSITION_KEY); if (!raw) return null; var parsed = JSON.parse(raw); if (typeof parsed.left !== 'number' || typeof parsed.top !== 'number') return null; return parsed; } catch (e) { return null; } } function writeStoredBannerPosition(pos) { try { window.localStorage.setItem(BANNER_POSITION_KEY, JSON.stringify(pos)); } catch (e) {} } function applyStoredBannerPosition(el) { var pos = readStoredBannerPosition(); if (!pos) return; var rect = el.getBoundingClientRect(); var clamped = clampPosition(pos.left, pos.top, rect.width || 340, rect.height || 110); el.style.left = clamped.left + 'px'; el.style.top = clamped.top + 'px'; el.style.right = 'auto'; el.style.bottom = 'auto'; el.style.transform = 'none'; } function makeBannerDraggable(el) { // Only the handle initiates drags; clicks inside the body/buttons don't. var handle = el.querySelector('.free-trial-enterprise-banner__handle'); if (!handle) return; var startX = 0, startY = 0; var originLeft = 0, originTop = 0; var dragging = false; var pointerId = null; handle.addEventListener('pointerdown', function (e) { if (e.button !== undefined && e.button !== 0) return; var rect = el.getBoundingClientRect(); startX = e.clientX; startY = e.clientY; originLeft = rect.left; originTop = rect.top; pointerId = e.pointerId; dragging = false; }); handle.addEventListener('pointermove', function (e) { if (pointerId === null || e.pointerId !== pointerId) return; var dx = e.clientX - startX; var dy = e.clientY - startY; if (!dragging && Math.abs(dx) < DRAG_THRESHOLD && Math.abs(dy) < DRAG_THRESHOLD) return; if (!dragging) { dragging = true; el.classList.add('free-trial-enterprise-banner--dragging'); try { handle.setPointerCapture(pointerId); } catch (err) {} } var rect = el.getBoundingClientRect(); var next = clampPosition(originLeft + dx, originTop + dy, rect.width, rect.height); el.style.left = next.left + 'px'; el.style.top = next.top + 'px'; el.style.right = 'auto'; el.style.bottom = 'auto'; el.style.transform = 'none'; e.preventDefault(); }); function endDrag(e) { if (pointerId === null) return; if (e && e.pointerId !== pointerId) return; try { handle.releasePointerCapture(pointerId); } catch (err) {} pointerId = null; if (dragging) { el.classList.remove('free-trial-enterprise-banner--dragging'); var rect = el.getBoundingClientRect(); writeStoredBannerPosition({ left: rect.left, top: rect.top }); // Swallow the click that would otherwise hit any nested button after // a drag — banner buttons (Talk to sales, Exit, Enter) check this. el.dataset.dragSuppressClick = '1'; setTimeout(function () { el.dataset.dragSuppressClick = ''; }, 0); } dragging = false; } handle.addEventListener('pointerup', endDrag); handle.addEventListener('pointercancel', endDrag); } // Re-clamp saved position into view on resize (e.g. orientation change, // browser window shrunk) so the pill and lock banner can never end up // off-screen. window.addEventListener('resize', function () { document.querySelectorAll('.simplify-toggle').forEach(function (btn) { var pos = readStoredPosition(); if (!pos) return; var rect = btn.getBoundingClientRect(); var clamped = clampPosition(pos.left, pos.top, rect.width, rect.height); btn.style.left = clamped.left + 'px'; btn.style.top = clamped.top + 'px'; btn.style.right = 'auto'; btn.style.bottom = 'auto'; if (clamped.left !== pos.left || clamped.top !== pos.top) { writeStoredPosition(clamped); } }); document.querySelectorAll('.free-trial-enterprise-banner').forEach(function (el) { var pos = readStoredBannerPosition(); if (!pos) return; var rect = el.getBoundingClientRect(); var clamped = clampPosition(pos.left, pos.top, rect.width, rect.height); el.style.left = clamped.left + 'px'; el.style.top = clamped.top + 'px'; el.style.right = 'auto'; el.style.bottom = 'auto'; el.style.transform = 'none'; if (clamped.left !== pos.left || clamped.top !== pos.top) { writeStoredBannerPosition(clamped); } }); }); function injectToggle() { // Floating fixed-position button attached to . Theme-independent — // doesn't rely on Mintlify's navbar DOM, which has changed across versions // and does not expose a stable injection target in the current maple theme. if (document.querySelector('.simplify-toggle')) { // Re-apply stored position in case the DOM was re-rendered around us. document.querySelectorAll('.simplify-toggle').forEach(applyStoredPosition); return; } if (!document.body) return; var btn = createToggleButton(); document.body.appendChild(btn); applyStoredPosition(btn); } // Wires up the explicit Enter / Exit buttons on the /platform/open-platform // landing page. Shows a confirmation panel once the user is in Open platform mode. function updateLandingPageStatus() { var active = document.documentElement.dataset.simplified === 'true'; var status = document.getElementById('simplified-mode-status'); var enter = document.getElementById('simplified-mode-enter'); if (status) { if (active) status.removeAttribute('hidden'); else status.setAttribute('hidden', ''); } if (enter) enter.classList.toggle('simplified-mode-cta--disabled', active); } function wireLandingPageButtons() { var enter = document.getElementById('simplified-mode-enter'); if (enter && !enter.dataset.simplifyBound) { enter.dataset.simplifyBound = '1'; enter.addEventListener('click', function (e) { e.preventDefault(); writeStoredPreference(true); // Land on the home page in Open platform mode so the user sees the // filtered experience immediately. window.location.href = '/?view=simplified'; }); } var exit = document.getElementById('simplified-mode-exit'); if (exit && !exit.dataset.simplifyBound) { exit.dataset.simplifyBound = '1'; exit.addEventListener('click', function (e) { e.preventDefault(); setSimplified(false); document.querySelectorAll('.simplify-toggle').forEach(function (b) { updateButton(b, false); }); markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); applyDeveloperContent(); applyEnterpriseBanner(); applyOpenPlatformOnlyBanner(); updateLandingPageStatus(); }); } updateLandingPageStatus(); } // Run our DOM passes synchronously on nav. The previous 150ms setTimeout // (and, in the first cut of PR #454, a doubled sync + rAF pass) is gone: // the MutationObserver attached to the sidebar root re-marks any late // Mintlify re-renders without us having to schedule a defensive second // pass on every nav. `onNav` is also throttled to one call per // animation frame so back-to-back triggers (history hook + popstate + // poll fallback all firing for the same navigation) collapse into a // single DOM pass. function runPasses() { injectToggle(); markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); applyDeveloperContent(); applyEnterpriseBanner(); applyOpenPlatformOnlyBanner(); wireLandingPageButtons(); applyTabClass(); observeSidebar(); } var _navScheduled = false; function onNav() { if (_navScheduled) return; _navScheduled = true; requestAnimationFrame(function () { _navScheduled = false; runPasses(); }); } // Apply preference immediately (before paint). // Precedence: localStorage preference > ?view=simplified URL flag. // The URL flag is still honoured as a one-shot entry point and promoted to // the stored preference so the mode sticks. if (hasUrlFlag() && !readStoredPreference()) { writeStoredPreference(true); } setSimplified(isSimplified()); // Initial pass runs synchronously (no rAF throttling) so the very first // paint is already marked — we don't want a one-frame flash of the // unfiltered sidebar on cold loads. Subsequent SPA navigations go through // the throttled onNav. if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', runPasses); } else { runPasses(); } // Re-run on Mintlify SPA navigations. We previously monkey-patched // history.pushState to (a) trigger onNav and (b) inject ?view=simplified // into the outgoing URL. That second behaviour was rewriting URLs Mintlify's // router was in the middle of resolving and produced a visible // "double-paint" on docs.poly.ai (and made the search bar unusable, since // every keystroke-driven navigation got its URL silently changed). // // Detect SPA navigations by polling location.pathname + location.search // instead. The check is cheap and runs only after a real URL change. The // preference is still kept in localStorage, so Open platform mode survives // navigation without needing the query param on every link. var _lastUrl = window.location.pathname + window.location.search; function checkUrlChange() { var current = window.location.pathname + window.location.search; if (current !== _lastUrl) { _lastUrl = current; onNav(); } } // Hook the existing history methods without rewriting the URL. ['pushState', 'replaceState'].forEach(function (m) { var orig = history[m]; history[m] = function () { var ret = orig.apply(this, arguments); checkUrlChange(); return ret; }; }); window.addEventListener('popstate', onNav); // Fallback: poll for URL changes the SPA may make outside history methods. setInterval(checkUrlChange, 500); // Watch the sidebar for re-renders. When Mintlify replaces the sidebar // DOM after navigation (or as a result of search interactions), re-apply // the dim/hide marks without waiting for the next URL change. This is // what makes the experience feel non-flickery: as soon as the sidebar // exists, it's already marked. function observeSidebar() { var sidebarRoot = document.getElementById('sidebar-content') || document.getElementById('sidebar') || document.querySelector('aside'); if (!sidebarRoot || sidebarRoot.dataset.simplifyObserved === '1') return; sidebarRoot.dataset.simplifyObserved = '1'; var scheduled = false; var observer = new MutationObserver(function () { if (scheduled) return; scheduled = true; requestAnimationFrame(function () { scheduled = false; markSidebarGroups(); markNavbarTabs(); markGlobalAnchors(); }); }); observer.observe(sidebarRoot, { childList: true, subtree: true }); } // Try to attach the observer immediately; onNav re-attaches on every // route change in case the sidebar root node itself was replaced. observeSidebar(); // ── Tab class injection ─────────────────────────────────────────────────── // Set data-tab on based on the current path so the stylesheet can // scope per-section visuals. Folded into runPasses() so it runs on every // SPA navigation, not just popstate. function applyTabClass() { var path = window.location.pathname; var tab = 'helpcenter'; if (/^\/(tools|secrets|extend|configuration-builder|call-handoff|call-data|flows\/(transition|object|asr|dtmf|few-shot)|api\/|developer)/.test(path)) { tab = 'developer'; } else if (/^\/learn\//.test(path)) { tab = 'academy'; } else if (/^\/api-reference\//.test(path)) { tab = 'api'; } else if (/^\/integrations\//.test(path)) { tab = 'integrations'; } else if (/^\/releases\//.test(path)) { tab = 'releases'; } document.documentElement.dataset.tab = tab; } // Initial synchronous set so the first paint has the right tab class // without waiting for runPasses() to be defined/called. applyTabClass(); })();

Documentation Index

Authorizations

Body

Response