<!-- SPDX-License-Identifier: Apache-2.0 OR MIT -->
<!DOCTYPE html>
<html lang="en-GB">
<head>
<meta charset="utf-8" />
<link rel="preconnect" href="https://cloudcdn.pro" crossorigin />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>API Reference</title>
<meta name="author" content="support@polaris.example.com (Polaris)">
<meta name="description" content="REST API reference for Polaris.">
<meta name="keywords" content="docs, ssg, static site generator, rust, example">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="accessibility" content="ARIA" />
<meta name="accessibility" content="fullKeyboardControl" />
<meta name="accessibility" content="noFlashingHazard" />
<meta name="apple-mobile-web-app-capable" content="yes"><meta name="mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<meta name="apple-mobile-web-app-title" content="Polaris">
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline'; connect-src 'self' ws://localhost:*; img-src 'self' data: https:; style-src 'self' 'unsafe-inline'; font-src 'self'; media-src 'self';" />
<link rel="alternate" href="https://docs.polaris.example.com" hreflang="en" />
<link rel="icon" type="image/x-icon" href="https://cloudcdn.pro/kaishi/v1/favicon.ico" />
<link rel="apple-touch-icon" href="https://cloudcdn.pro/kaishi/v1/icons/192x192.png" sizes="192x192" />
<meta name="theme-color" content="rgb(26, 58, 138)" />
<link rel="manifest" href="/manifest.json" />
<link rel="alternate" type="application/rss+xml" href="/rss.xml" />
<style>
:root{--vp-bg:#fff;--vp-bs:#f6f6f7;--vp-ba:#f6f6f7;--vp-t1:rgba(60,60,67);--vp-t2:rgba(60,60,67,.78);--vp-t3:#545458;--vp-br:#1a3a8a;--vp-bl:#1e429f;--vp-bd:rgba(60,60,67,.12);--vp-nh:64px}
[data-theme="dark"]{--vp-bg:#1b1b1f;--vp-bs:#202127;--vp-ba:#161618;--vp-t1:rgba(255,255,245,.86);--vp-t2:rgba(235,235,245,.6);--vp-t3:#a1a1aa;--vp-br:#a8b1ff;--vp-bl:#c3c9ff;--vp-bd:rgba(84,84,89,.48)}
@media(prefers-color-scheme:dark){:root:not([data-theme="light"]){--vp-bg:#1b1b1f;--vp-bs:#202127;--vp-ba:#161618;--vp-t1:rgba(255,255,245,.86);--vp-t2:rgba(235,235,245,.6);--vp-t3:#a1a1aa;--vp-br:#a8b1ff;--vp-bl:#c3c9ff;--vp-bd:rgba(84,84,89,.48)}}
*,*::before,*::after{box-sizing:border-box;margin:0;padding:0}
html{scroll-behavior:smooth;-webkit-text-size-adjust:100%}
body{font-family:Inter,-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;font-size:16px;line-height:1.7;color:var(--vp-t1);background:var(--vp-bg)}
a{color:var(--vp-br);text-decoration:underline;text-underline-offset:2px}
a:hover{color:var(--vp-bl)}
img{max-width:100%;height:auto;display:block}
h1,h2,h3,h4,h5,h6{font-weight:600;color:var(--vp-t1)}
h1{font-size:clamp(1.75rem,4vw,2.5rem);margin:1.5rem 0 1rem}
h2{font-size:clamp(1.35rem,3vw,1.75rem);margin:2rem 0 .75rem;padding-bottom:.75rem;border-bottom:1px solid var(--vp-bd)}
h3{font-size:1.25rem;margin:1.5rem 0 .5rem}
p{margin:.75rem 0}
strong{font-weight:600}
code,pre{font-family:ui-monospace,SFMono-Regular,Menlo,monospace;font-size:.875em}
pre{background:var(--vp-bs);border:1px solid var(--vp-bd);border-radius:8px;color:var(--vp-t1);overflow-x:auto;padding:1rem 1.25rem}
code{background:var(--vp-bs);border-radius:4px;padding:.15em .35em}
pre code{background:none;padding:0}
.skip-link{position:absolute;top:-100%;left:1rem;background:var(--vp-br);color:#fff;padding:.5rem 1rem;border-radius:8px;z-index:1000;font-weight:600}
.skip-link:focus{top:1rem;outline:none}
.nav{position:fixed;top:0;left:0;right:0;z-index:100;height:var(--vp-nh);background:var(--vp-bg);backdrop-filter:blur(12px);-webkit-backdrop-filter:blur(12px);border-bottom:1px solid var(--vp-bd)}
.nav-inner{display:flex;align-items:center;height:var(--vp-nh);max-width:1376px;margin:0 auto;padding:0 24px}
.nav-brand{display:flex;align-items:center;gap:8px;text-decoration:none;color:var(--vp-t1);font-weight:600;flex-shrink:0}
.nav-links a,.nav-item a,.footer-col a,.nav-brand,.skip-link,.btn-brand,.btn-alt,.btn-submit,.breadcrumb a,.lang-dropdown a,.mobile-menu a{text-decoration:none}
.nav-brand img{width:28px;height:28px}
.nav-search{display:flex;align-items:center;gap:8px;border:1px solid var(--vp-bd);border-radius:8px;padding:6px 14px;cursor:pointer;background:none;color:var(--vp-t3);font-size:14px;margin-left:auto;margin-right:16px}
.nav-search:hover{border-color:var(--vp-br)}
.nav-search svg{width:16px;height:16px;stroke:currentColor;stroke-width:2;fill:none}
.nav-search kbd{font-size:11px;border:1px solid var(--vp-bd);border-radius:4px;padding:1px 5px;margin-left:8px;background:var(--vp-bs);color:var(--vp-t3)}
.nav-links{display:flex;align-items:center;gap:4px}
.nav-links a{padding:4px 12px;color:var(--vp-t1);font-size:14px;font-weight:500}
.nav-links a:hover{color:var(--vp-br)}
.nav-controls{display:flex;align-items:center;gap:8px;margin-left:16px;flex-shrink:0}
.lang-btn{position:relative;background:none;border:none;cursor:pointer;color:var(--vp-t2);padding:4px;display:flex;align-items:center}
.lang-btn svg{width:20px;height:20px;stroke:currentColor;stroke-width:1.5;fill:none}
.lang-dropdown{display:none;position:absolute;top:calc(100% + 8px);right:0;background:var(--vp-bg);border:1px solid var(--vp-bd);border-radius:8px;padding:4px;min-width:120px}
.lang-dropdown.open{display:block}
.lang-dropdown a{display:block;padding:6px 12px;color:var(--vp-t1);font-size:13px;border-radius:4px}
.lang-dropdown a:hover{background:var(--vp-bs)}
.theme-switch{position:relative;width:40px;height:22px;background:var(--vp-bs);border:1px solid var(--vp-bd);border-radius:11px;cursor:pointer;padding:0;flex-shrink:0}
.theme-switch::before{content:'';position:absolute;top:2px;left:2px;width:16px;height:16px;border-radius:50%;background:var(--vp-t2);transition:transform .25s}
[data-theme="dark"] .theme-switch::before,.theme-switch.dark::before{transform:translateX(18px)}
.theme-switch .sun-svg,.theme-switch .moon-svg{position:absolute;top:3px;width:14px;height:14px;stroke:var(--vp-t3);stroke-width:2;fill:none}
.theme-switch .sun-svg{left:3px}
.theme-switch .moon-svg{right:3px}
.menu-toggle{display:none;background:none;border:1px solid var(--vp-bd);border-radius:6px;padding:4px 6px;cursor:pointer;color:var(--vp-t1)}
.menu-toggle svg{width:20px;height:20px;stroke:currentColor;stroke-width:2;fill:none}
.hero{padding:calc(var(--vp-nh) + 60px) 24px 80px;text-align:center;max-width:960px;margin:0 auto}
.hero-name{font-size:clamp(2rem,5vw,3.5rem);font-weight:700;line-height:1.1;background:linear-gradient(120deg,var(--vp-br) 30%,#41d1ff);-webkit-background-clip:text;-webkit-text-fill-color:transparent;background-clip:text;margin-bottom:1rem}
.hero-tagline{font-size:clamp(1rem,2vw,1.25rem);color:var(--vp-t2);line-height:1.6;max-width:560px;margin:0 auto 2rem}
.hero-actions{display:flex;gap:12px;justify-content:center;flex-wrap:wrap}
.btn-brand,.btn-alt,.btn-submit{display:inline-flex;align-items:center;padding:10px 24px;border-radius:20px;font-size:15px;cursor:pointer;border:none}
.btn-brand,.btn-submit{background:#1a3a8a;color:#fff;font-weight:600}
.btn-brand:hover,.btn-submit:hover{background:var(--vp-bl)}
.btn-alt{background:transparent;color:var(--vp-t1);border:1px solid var(--vp-bd);font-weight:500}
.btn-alt:hover{border-color:var(--vp-br)}
.hero-banner{margin:2rem auto 0;max-width:720px;border-radius:12px;overflow:hidden;box-shadow:0 8px 28px rgba(0,0,0,.12)}
.hero-banner img{width:100%;display:block}
.content-wrap{max-width:740px;margin:0 auto;padding:48px 24px;margin-top:var(--vp-nh)}
.content{font-size:16px;line-height:1.7;color:var(--vp-t1)}
.content ul,.content ol{padding-left:1.25rem;margin:.75rem 0}
.content li{margin:.25rem 0}
.breadcrumb{font-size:14px;color:var(--vp-t3);margin-bottom:24px}
.breadcrumb a{color:var(--vp-br)}
.breadcrumb span{margin:0 6px}
.article-meta{font-size:14px;color:var(--vp-t2);margin-bottom:2rem;display:flex;gap:12px;align-items:center}
.footer{background:var(--vp-ba);padding:48px 24px 24px}
.footer-inner{max-width:1152px;margin:0 auto}
.footer-cols{display:grid;grid-template-columns:repeat(3,1fr);gap:32px;margin-bottom:32px}
.footer-heading{font-size:14px;font-weight:700;color:var(--vp-t1);margin-bottom:12px;text-transform:uppercase;letter-spacing:.5px}
.footer-col a{display:block;color:var(--vp-br);font-size:14px;padding:3px 0;text-decoration:underline}
.footer-col a:hover{color:var(--vp-br)}
.footer-bottom{border-top:1px solid var(--vp-bd);padding-top:20px;text-align:center;color:var(--vp-t3);font-size:13px}
.form-card{background:var(--vp-bs);border:1px solid var(--vp-bd);border-radius:12px;padding:2rem;max-width:520px;margin:2rem auto 0}
.form-group{display:flex;flex-direction:column;gap:6px;margin-bottom:1.25rem}
.form-group label{font-weight:600;font-size:14px;color:var(--vp-t1)}
.form-group input,.form-group select,.form-group textarea{background:var(--vp-bg);color:var(--vp-t1);border:1px solid var(--vp-bd);border-radius:8px;padding:8px 12px;font-family:inherit;font-size:15px}
.form-group input:focus,.form-group select:focus,.form-group textarea:focus{border-color:var(--vp-br);outline:2px solid var(--vp-br);outline-offset:1px}
.form-group textarea{resize:vertical;min-height:120px}
:focus-visible{outline:2px solid var(--vp-br);outline-offset:2px}
.navbar-nav{display:flex;align-items:center;gap:0;list-style:none;margin:0;padding:0}
.nav-item{display:inline-flex}
.nav-item a{display:block;padding:4px 12px;color:var(--vp-t1);font-size:14px;font-weight:500;text-decoration:none;text-transform:none}
.nav-item a:hover{color:var(--vp-br)}
.nav-item a.text-uppercase{text-transform:none}
.nav-item a.p-2{padding:4px 12px}
.ms-auto{margin-left:auto}.mb-2{margin-bottom:0}.mb-lg-0{margin-bottom:0}
#ssg-search-btn{display:none!important}
.content{overflow:hidden}
.content img{max-width:100%;height:auto;border-radius:8px;margin:1.5rem 0;display:block}
.content .img-fluid{max-width:100%;height:auto;border-radius:8px}
.content .w-50{max-width:50%}
.content .float-start{float:left;margin:0 1.5rem 1rem 0}
.content .float-end{float:right;margin:0 0 1rem 1.5rem}
.content .p-5{padding:0}
.content .mb-3{margin-bottom:1rem}
.content .fw-bold{font-weight:600}
.content .text-danger{color:var(--vp-br)}
.content .display-1{font-size:2rem;font-weight:600}
.content::after{content:"";display:table;clear:both}
.mobile-menu{display:none}@media(max-width:768px){.nav-controls{margin-left:auto}.content .w-50{max-width:100%}.content .float-start,.content .float-end{float:none;margin:1rem 0}.nav-links,.nav-search,.navbar-nav{display:none}.menu-toggle{display:flex}.nav-controls .lang-btn{display:none}.mobile-menu{display:none;position:fixed;top:var(--vp-nh);left:0;right:0;bottom:0;background:var(--vp-bg);padding:24px;z-index:99;overflow-y:auto}.mobile-menu.open{display:block}.mobile-menu a,.mobile-menu .nav-item a{display:block;padding:10px 0;font-size:15px;color:var(--vp-t1);border-bottom:1px solid var(--vp-bd)}.mobile-menu .navbar-nav{display:block}.mobile-menu .nav-item{display:block}.hero{padding:calc(var(--vp-nh) + 32px) 16px 48px}.hero-name{font-size:clamp(1.75rem,6vw,2.5rem)}.content-wrap{padding:32px 16px}.footer-cols{grid-template-columns:1fr;gap:24px}}
</style>
<link rel="alternate" type="application/atom+xml" title="Atom Feed" href="http://127.0.0.1:3003/atom.xml"/>
<meta name="robots" content="max-snippet:-1, max-image-preview:large, max-video-preview:-1">
<meta property="og:title" content="API Reference">
<meta property="og:description" content="Home &gt; API Reference Base URL https://api.polaris.example.com/v1 All routes use JSON. Pass a bearer token to log in. Endpoints Method Path Purpose GET">
<meta property="og:type" content="website">
<meta property="og:url" content="https://docs.polaris.example.com">
<meta property="og:locale" content="en_GB">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="API Reference">
<meta name="twitter:description" content="Home &gt; API Reference Base URL https://api.polaris.example.com/v1 All routes use JSON. Pass a bearer token to log in. Endpoints Method Path Purpose GET">
<link rel="canonical" href="http://127.0.0.1:3003/plugin-api/index.html">
<style>/* ssg-single-locale: hide lang */.lang-btn,.lang-dropdown,.mobile-lang{display:none!important}</style></head>
<body id="page-top" itemscope itemtype="http://schema.org/WebPage">
<a class="skip-link" href="#main">Skip to content</a>
<nav class="nav" id="mainNav" itemscope itemtype="http://schema.org/SiteNavigationElement" aria-label="Main navigation">
<div class="nav-inner">
<a class="nav-brand" href="/" />
<img width="100" height="33" src="" alt="" role="presentation" />
<span itemprop="name">Polaris</span>
</a>
<button class="nav-search" type="button" aria-label="Search">
<svg aria-hidden="true" viewBox="0 0 24 24"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
<span>Search</span>
<kbd>⌘K</kbd>
</button>
<div class="nav-links" id="navLinks">
<ul class="navbar-nav ms-auto mb-2 mb-lg-0"><li class="nav-item"><a aria-label="Configuration" href="/configuration/index.html" title="Navigation link for the Configuration page" class="text-uppercase p-2">Configuration</a></li><li class="nav-item"><a aria-label="Contact" href="/contact/index.html" title="Navigation link for the Contact page" class="text-uppercase p-2">Contact</a></li><li class="nav-item"><a aria-label="Getting Started" href="/getting-started/index.html" title="Navigation link for the Getting Started page" class="text-uppercase p-2">Getting Started</a></li><li class="nav-item"><a aria-label="Plugin Api" href="/plugin-api/index.html" title="Navigation link for the Plugin Api page" class="text-uppercase p-2">Plugin Api</a></li><li class="nav-item"><a aria-label="Posts" href="/posts/index.html" title="Navigation link for the Posts page" class="text-uppercase p-2">Posts</a></li><li class="nav-item"><a aria-label="Tags" href="/tags/index.html" title="Navigation link for the Tags page" class="text-uppercase p-2">Tags</a></li></ul>
</div>
<div class="nav-controls">
<div style="position:relative">
<button class="lang-btn" type="button" aria-label="Select language" id="langToggle">
<svg aria-hidden="true" viewBox="0 0 24 24"><circle cx="12" cy="12" r="10"/><line x1="2" y1="12" x2="22" y2="12"/><path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10A15.3 15.3 0 0 1 12 2z"/></svg>
</button>
<!-- ssg:lang-switcher -->
</div>
<button class="theme-switch" type="button" aria-label="Toggle dark mode" id="themeToggle">
<svg aria-hidden="true" class="sun-svg" viewBox="0 0 24 24"><circle cx="12" cy="12" r="4"/><path d="M12 2v2M12 20v2M4.93 4.93l1.41 1.41M17.66 17.66l1.41 1.41M2 12h2M20 12h2M4.93 19.07l1.41-1.41M17.66 6.34l1.41-1.41"/></svg>
<svg aria-hidden="true" class="moon-svg" viewBox="0 0 24 24"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/></svg>
</button>
</div>
<button class="menu-toggle" type="button" aria-controls="mobileMenu" aria-expanded="false" aria-label="Toggle navigation">
<svg aria-hidden="true" viewBox="0 0 24 24"><line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/></svg>
</button>
</div>
</nav>
<div class="mobile-menu" id="mobileMenu" role="navigation" aria-label="Mobile navigation">
<ul class="navbar-nav ms-auto mb-2 mb-lg-0"><li class="nav-item"><a aria-label="Configuration" href="/configuration/index.html" title="Navigation link for the Configuration page" class="text-uppercase p-2">Configuration</a></li><li class="nav-item"><a aria-label="Contact" href="/contact/index.html" title="Navigation link for the Contact page" class="text-uppercase p-2">Contact</a></li><li class="nav-item"><a aria-label="Getting Started" href="/getting-started/index.html" title="Navigation link for the Getting Started page" class="text-uppercase p-2">Getting Started</a></li><li class="nav-item"><a aria-label="Plugin Api" href="/plugin-api/index.html" title="Navigation link for the Plugin Api page" class="text-uppercase p-2">Plugin Api</a></li><li class="nav-item"><a aria-label="Posts" href="/posts/index.html" title="Navigation link for the Posts page" class="text-uppercase p-2">Posts</a></li><li class="nav-item"><a aria-label="Tags" href="/tags/index.html" title="Navigation link for the Tags page" class="text-uppercase p-2">Tags</a></li></ul>
<!-- ssg:lang-switcher -->
</div>
<main id="main" class="content-wrap" aria-label="Main content">
<div class="breadcrumb">
<a href="/">Home</a><span>></span><span>API Reference</span>
</div>
<div class="content"><h2>Base URL</h2>
<pre><code>https://api.polaris.example.com/v1
</code></pre>
<p>All routes use JSON. Pass a bearer token to log in.</p>
<h2>Endpoints</h2>
<div class="table-responsive"><table class="table">
<thead>
<tr>
<th>Method</th>
<th>Path</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left">GET</td>
<td class="text-left"><code>/datasets</code></td>
<td class="text-left">List datasets you can read</td>
</tr>
<tr>
<td class="text-left">GET</td>
<td class="text-left"><code>/datasets/{id}</code></td>
<td class="text-left">Get one dataset's metadata</td>
</tr>
<tr>
<td class="text-left">POST</td>
<td class="text-left"><code>/datasets/{id}/queries</code></td>
<td class="text-left">Run a query on a dataset</td>
</tr>
<tr>
<td class="text-left">GET</td>
<td class="text-left"><code>/queries/{id}</code></td>
<td class="text-left">Poll a query for results</td>
</tr>
<tr>
<td class="text-left">DELETE</td>
<td class="text-left"><code>/queries/{id}</code></td>
<td class="text-left">Cancel a running query</td>
</tr>
</tbody>
</table></div>
<h2>Example: submit a query</h2>
<pre><code class="language-sh"><pre style="background-color:#2b303b;">
<span style="color:#8fa1b3;">curl</span><span style="color:#bf616a;"> -X</span><span style="color:#c0c5ce;"> POST \
</span><span style="color:#bf616a;"> -H </span><span style="color:#c0c5ce;">"</span><span style="color:#a3be8c;">Authorization: Bearer </span><span style="color:#c0c5ce;">$</span><span style="color:#bf616a;">POLARIS_TOKEN</span><span style="color:#c0c5ce;">" \
</span><span style="color:#bf616a;"> -H </span><span style="color:#c0c5ce;">"</span><span style="color:#a3be8c;">Content-Type: application/json</span><span style="color:#c0c5ce;">" \
</span><span style="color:#bf616a;"> -d </span><span style="color:#c0c5ce;">'</span><span style="color:#a3be8c;">{"sql": "select count(*) from events"}</span><span style="color:#c0c5ce;">' \
</span><span style="color:#c0c5ce;"> https://api.polaris.example.com/v1/datasets/my-dataset/queries
</span></pre>
</code></pre>
<p>Response:</p>
<pre><code class="language-json"><pre style="background-color:#2b303b;">
<span style="color:#c0c5ce;">{
</span><span style="color:#c0c5ce;"> "</span><span style="color:#a3be8c;">query_id</span><span style="color:#c0c5ce;">": "</span><span style="color:#a3be8c;">q_01HZ2K9X8R7Y6V5T4S3R2Q1P0</span><span style="color:#c0c5ce;">",
</span><span style="color:#c0c5ce;"> "</span><span style="color:#a3be8c;">status</span><span style="color:#c0c5ce;">": "</span><span style="color:#a3be8c;">running</span><span style="color:#c0c5ce;">",
</span><span style="color:#c0c5ce;"> "</span><span style="color:#a3be8c;">submitted_at</span><span style="color:#c0c5ce;">": "</span><span style="color:#a3be8c;">2026-04-16T09:30:00Z</span><span style="color:#c0c5ce;">"
</span><span style="color:#c0c5ce;">}
</span></pre>
</code></pre>
<h2>Error codes</h2>
<table>
<thead>
<tr>
<th>Code</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td class="text-left">400</td>
<td class="text-left">Bad JSON, bad SQL, or missing field</td>
</tr>
<tr>
<td class="text-left">401</td>
<td class="text-left">Missing or expired token</td>
</tr>
<tr>
<td class="text-left">403</td>
<td class="text-left">Token valid but no access to this dataset</td>
</tr>
<tr>
<td class="text-left">404</td>
<td class="text-left">Dataset or query ID not found</td>
</tr>
<tr>
<td class="text-left">429</td>
<td class="text-left">Rate limit hit — see <code>Retry-After</code> header</td>
</tr>
<tr>
<td class="text-left">500</td>
<td class="text-left">Server error — please <a href="/contact/">report it</a></td>
</tr>
</tbody>
</table>
</div>
</main>
<footer class="footer" id="footer" aria-label="Footer">
<div class="footer-inner">
<div class="footer-cols">
<div class="footer-col">
<p class="footer-heading">About</p>
<a href="/">Home</a>
<a href="/contact/index.html">Contact</a>
</div>
<div class="footer-col">
<p class="footer-heading">Resources</p>
<a href="/posts/index.html">Blog</a>
<a href="/rss.xml">RSS Feed</a>
</div>
<div class="footer-col">
<p class="footer-heading">Legal</p>
<a href="/privacy/index.html">Privacy</a>
</div>
</div>
<div class="footer-bottom">Copyright © 2024-2026 Polaris. All rights reserved.</div>
</div>
</footer>
<script type="application/ld+json">
{"@context":"https://schema.org/","@type":"WebPage","author":{"@type":"Person","@id":"support@polaris.example.com (Polaris)"},"copyrightHolder":{"@type":"Person","@id":"support@polaris.example.com (Polaris)"},"copyrightYear":"Copyright © 2024-2026 Polaris. All rights reserved.","creator":{"@type":"Person","@id":"support@polaris.example.com (Polaris)"},"dateModified":"2026-04-16T00:00:00+00:00","datePublished":"2026-04-16T00:00:00+00:00","description":"REST API reference for Polaris.","headline":"REST endpoints, request/response shapes, and error codes.","image":{"@type":"ImageObject","url":""},"inLanguage":"en-GB","mainEntityOfPage":"https://docs.polaris.example.com/plugin-api/","name":"Polaris","publisher":{"@type":"Person","@id":"support@polaris.example.com (Polaris)"}}
</script>
<script>
(function(){var r=document.documentElement,sw=document.getElementById('themeToggle'),lt=document.getElementById('langToggle'),ld=document.getElementById('langDropdown'),mt=document.querySelector('.menu-toggle'),mm=document.getElementById('mobileMenu');function setTheme(v){r.setAttribute('data-theme',v);localStorage.setItem('vitepress-theme-appearance',v);if(v==='dark')sw.classList.add('dark');else sw.classList.remove('dark')}var saved=localStorage.getItem('vitepress-theme-appearance');if(saved)setTheme(saved);else if(matchMedia('(prefers-color-scheme:dark)').matches)setTheme('dark');var ns=document.querySelector('.nav-search');if(ns)ns.addEventListener('click',function(){var b=document.getElementById('ssg-search-btn');if(b){b.click()}else{var o=document.getElementById('ssg-search-overlay');if(o){o.classList.add('active');var inp=document.getElementById('ssg-search-input');if(inp){inp.value='';inp.focus()}}}});sw.addEventListener('click',function(){setTheme(r.getAttribute('data-theme')==='dark'?'light':'dark')});if(lt)lt.addEventListener('click',function(e){e.stopPropagation();ld.classList.toggle('open')});document.addEventListener('click',function(){if(ld)ld.classList.remove('open')});if(mt)mt.addEventListener('click',function(){var ex=this.getAttribute('aria-expanded')==='true';this.setAttribute('aria-expanded',!ex);mm.classList.toggle('open')});var lp=location.pathname.match(/^\/(en|fr)\//);if(lp){var pfx='/'+lp[1];document.querySelectorAll('a[href^="/"]').forEach(function(a){var h=a.getAttribute('href');if(h&&h.charAt(0)==='/'&&!/^\/(en|fr)\//.test(h)){a.setAttribute('href',pfx+h)}})}})();
</script>
<!-- SSG Search Widget -->
<div id="ssg-search-widget">
<style>
/* ── Trigger button (always visible) ── */
#ssg-search-btn{position:fixed;top:16px;right:16px;z-index:9998;display:flex;align-items:center;gap:8px;padding:8px 16px;background:#fff;border:1px solid #d1d5db;border-radius:8px;cursor:pointer;font-family:-apple-system,system-ui,sans-serif;font-size:14px;color:#595960;box-shadow:0 1px 3px rgba(0,0,0,.08);transition:border-color .15s,box-shadow .15s}
#ssg-search-btn:hover{border-color:#595960;box-shadow:0 2px 6px rgba(0,0,0,.12)}
#ssg-search-btn svg{width:16px;height:16px;stroke:currentColor;fill:none;stroke-width:2;stroke-linecap:round;stroke-linejoin:round}
#ssg-search-btn kbd{font-family:inherit;font-size:11px;padding:2px 6px;background:#f3f4f6;border:1px solid #e5e7eb;border-radius:4px;color:#595960;margin-left:4px}
/* ── Modal overlay ── */
#ssg-search-overlay{display:none;position:fixed;inset:0;z-index:9999;background:rgba(0,0,0,.5);align-items:flex-start;justify-content:center;padding-top:12vh}
#ssg-search-overlay.active{display:flex}
#ssg-search-box{background:#fff;border-radius:12px;width:92%;max-width:640px;box-shadow:0 25px 60px rgba(0,0,0,.3);overflow:hidden;font-family:-apple-system,system-ui,sans-serif}
#ssg-search-header{display:flex;align-items:center;padding:0 16px;border-bottom:1px solid #e5e7eb}
#ssg-search-header svg{width:20px;height:20px;stroke:#9ca3af;fill:none;stroke-width:2;flex-shrink:0}
#ssg-search-input{flex:1;padding:16px 12px;font-size:16px;border:none;outline:none;background:transparent}
#ssg-search-results{max-height:50vh;overflow-y:auto}
#ssg-sr-status{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}
.ssg-result{display:block;padding:12px 20px;text-decoration:none;color:#111;border-bottom:1px solid #f3f4f6;transition:background .1s}
.ssg-result:hover,.ssg-result.active{background:#ecfdf5}
.ssg-result-title{font-weight:600;font-size:15px;margin-bottom:3px}
.ssg-result-snippet{font-size:13px;color:#595960;line-height:1.5}
.ssg-result-snippet mark{background:#fef08a;color:inherit;border-radius:2px;padding:0 2px}
.ssg-no-results{padding:32px 20px;text-align:center;color:#595960;font-size:14px}
.ssg-no-results[role="status"]{}
/* Forced-colours / Windows High Contrast Mode */
@media(forced-colors:active){
#ssg-search-btn{border:1px solid ButtonText}
#ssg-search-btn:focus{outline:2px solid Highlight}
#ssg-search-input{border:1px solid CanvasText}
#ssg-search-input:focus{outline:2px solid Highlight}
.ssg-result:focus,.ssg-result.active{outline:2px solid Highlight}
.ssg-result-snippet mark{background:Highlight;color:HighlightText}
}
.ssg-search-footer{display:flex;gap:16px;padding:10px 20px;font-size:12px;color:#595960;border-top:1px solid #e5e7eb;justify-content:flex-end}
.ssg-search-footer kbd{font-family:inherit;font-size:11px;padding:1px 5px;background:#f3f4f6;border:1px solid #e5e7eb;border-radius:3px}
/* ── Dark mode (media query + data-theme attribute) ── */
@media(prefers-color-scheme:dark){
:root:not([data-theme="light"]) #ssg-search-btn{background:#1f2937;border-color:#374151;color:#cccccf}
:root:not([data-theme="light"]) #ssg-search-btn:hover{border-color:#4b5563}
:root:not([data-theme="light"]) #ssg-search-btn kbd{background:#374151;border-color:#4b5563;color:#cccccf}
:root:not([data-theme="light"]) #ssg-search-box{background:#1f2937;color:#f9fafb}
:root:not([data-theme="light"]) #ssg-search-header{border-color:#374151}
:root:not([data-theme="light"]) #ssg-search-input{color:#f9fafb}
:root:not([data-theme="light"]) .ssg-result{color:#f9fafb;border-color:#374151}
:root:not([data-theme="light"]) .ssg-result:hover,:root:not([data-theme="light"]) .ssg-result.active{background:#374151}
:root:not([data-theme="light"]) .ssg-result-snippet{color:#cccccf}
:root:not([data-theme="light"]) .ssg-result-snippet mark{background:#854d0e;color:#fef08a}
:root:not([data-theme="light"]) .ssg-no-results{color:#cccccf}
:root:not([data-theme="light"]) .ssg-search-footer{border-color:#374151;color:#cccccf}
:root:not([data-theme="light"]) .ssg-search-footer kbd{background:#374151;border-color:#4b5563}
}
[data-theme="dark"] #ssg-search-btn{background:#1f2937;border-color:#374151;color:#cccccf}
[data-theme="dark"] #ssg-search-btn:hover{border-color:#4b5563}
[data-theme="dark"] #ssg-search-btn kbd{background:#374151;border-color:#4b5563;color:#cccccf}
[data-theme="dark"] #ssg-search-box{background:#1f2937;color:#f9fafb}
[data-theme="dark"] #ssg-search-header{border-color:#374151}
[data-theme="dark"] #ssg-search-input{color:#f9fafb}
[data-theme="dark"] .ssg-result{color:#f9fafb;border-color:#374151}
[data-theme="dark"] .ssg-result:hover,[data-theme="dark"] .ssg-result.active{background:#374151}
[data-theme="dark"] .ssg-result-snippet{color:#cccccf}
[data-theme="dark"] .ssg-result-snippet mark{background:#854d0e;color:#fef08a}
[data-theme="dark"] .ssg-no-results{color:#cccccf}
[data-theme="dark"] .ssg-search-footer{border-color:#374151;color:#cccccf}
[data-theme="dark"] .ssg-search-footer kbd{background:#374151;border-color:#4b5563}
</style>
<!-- Search trigger button -->
<button id="ssg-search-btn" type="button" aria-label="Search">
<svg viewBox="0 0 24 24"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
<span>Search</span>
<kbd>K</kbd>
</button>
<!-- Search modal -->
<div id="ssg-search-overlay" role="dialog" aria-label="Search">
<div id="ssg-search-box">
<div id="ssg-search-header">
<svg viewBox="0 0 24 24"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
<input id="ssg-search-input" type="search" placeholder="Search documentation..." autocomplete="off" aria-label="Search"/>
</div>
<div id="ssg-search-results" aria-live="polite"></div>
<div id="ssg-sr-status" role="status" aria-live="polite" aria-atomic="true"></div>
<div class="ssg-search-footer"><span><kbd>Esc</kbd> close</span><span><kbd>↑</kbd><kbd>↓</kbd> navigate</span><span><kbd>Enter</kbd> open</span></div>
</div>
</div>
<script>
(function(){
var idx=null,overlay=document.getElementById('ssg-search-overlay'),
input=document.getElementById('ssg-search-input'),
results=document.getElementById('ssg-search-results'),
btn=document.getElementById('ssg-search-btn'),active=-1,
lm=location.pathname.match(/^\/(en|fr|ar|bn|cs|de|es|ha|he|hi|id|it|ja|ko|nl|pl|pt|ro|ru|sv|th|tl|tr|uk|vi|yo|zh-tw|zh)\//),
lp=lm?'/'+lm[1]:'';
function load(){if(idx)return Promise.resolve();var sp=lm?'/'+lm[1]+'/search-index.json':'/search-index.json';return fetch(sp).then(function(r){return r.json()}).then(function(d){idx=d.entries||[]}).catch(function(){idx=[]})}
function open(){load().then(function(){overlay.classList.add('active');input.value='';results.innerHTML='';input.focus();active=-1})}
function close(){overlay.classList.remove('active');active=-1}
function highlight(text,q){if(!q)return esc(text);var re=new RegExp('('+q.replace(/[.*+?^${}()|[\]\\]/g,'\\$&')+')','gi');return esc(text).replace(re,'<mark>$1</mark>')}
function esc(s){var d=document.createElement('div');d.textContent=s;return d.innerHTML}
function snippet(content,q,len){len=len||150;if(!q)return esc(content.substring(0,len));var i=content.toLowerCase().indexOf(q.toLowerCase());if(i<0)return esc(content.substring(0,len));var s=Math.max(0,i-50),e=Math.min(content.length,i+len);var t=(s>0?'...':'')+content.substring(s,e)+(e<content.length?'...':'');return highlight(t,q)}
function search(q){if(!idx||!q){results.innerHTML='';return}q=q.trim();if(!q){results.innerHTML='';return}var ql=q.toLowerCase(),hits=[];
for(var i=0;i<idx.length&&hits.length<20;i++){var e=idx[i],s=0;if(e.title.toLowerCase().indexOf(ql)>=0)s+=10;if(e.content.toLowerCase().indexOf(ql)>=0)s+=5;for(var h=0;h<e.headings.length;h++){if(e.headings[h].toLowerCase().indexOf(ql)>=0){s+=3;break}}if(s>0)hits.push({entry:e,score:s})}
hits.sort(function(a,b){return b.score-a.score});
var sr=document.getElementById('ssg-sr-status');
if(!hits.length){results.innerHTML='<div class="ssg-no-results" role="status">No results for ““\'+esc(q)+\'””</div>';if(sr)sr.textContent='No results found';return}
var html='';for(var j=0;j<hits.length;j++){var e=hits[j].entry;html+='<a class="ssg-result" href="'+esc(lp+e.url)+'">'+'<div class="ssg-result-title">'+highlight(e.title,q)+'</div>'+'<div class="ssg-result-snippet">'+snippet(e.content,q)+'</div></a>'}
results.innerHTML=html;active=-1;if(sr)sr.textContent=hits.length+' result'+(hits.length===1?'':'s')+' found'}
function nav(dir){var items=results.querySelectorAll('.ssg-result');if(!items.length)return;if(active>=0&&items[active])items[active].classList.remove('active');active+=dir;if(active<0)active=items.length-1;if(active>=items.length)active=0;items[active].classList.add('active');items[active].scrollIntoView({block:'nearest'})}
btn.addEventListener('click',function(){open()});
input.addEventListener('input',function(){search(this.value)});
overlay.addEventListener('click',function(e){if(e.target===overlay)close()});
document.addEventListener('keydown',function(e){if((e.ctrlKey||e.metaKey)&&e.key==='k'){e.preventDefault();if(overlay.classList.contains('active'))close();else open()}
if(!overlay.classList.contains('active'))return;if(e.key==='Escape')close();if(e.key==='ArrowDown'){e.preventDefault();nav(1)}if(e.key==='ArrowUp'){e.preventDefault();nav(-1)}
if(e.key==='Enter'){e.preventDefault();var items=results.querySelectorAll('.ssg-result');if(active>=0&&items[active])window.location=items[active].href;else if(items[0])window.location=items[0].href}})
})();
</script>
</div>
</body>
</html>