Skip to main content

​
Path

​
string
required
Your widget ID, from the widget page in the dashboard. Use demo-widget for the public demo widget, which renders on any site and doesn’t record analytics.

​
Query parameters

​
string
required
The article headline, URL-encoded. Used as a search query and for title similarity, which carries 40% of the match score. If the title is missing, matching relies on keywords alone.
​
string
Comma-separated keywords, URL-encoded. Each keyword becomes its own search query (up to five queries including the title). Carries 30% of the match score.Example: federal%20reserve%2Cinterest%20rates
​
boolean
default:"false"
Set to true to show a diagnostic panel with the score breakdown, and to show the candidate list instead of collapsing when nothing matches. Always available on demo-widget. On your own widgets, debug output is only shown when PolyEmbed has enabled debugging for the environment; otherwise the parameter is ignored.
​
string
Signed snippets only. The domain the snippet was signed for. Copy from the dashboard; don’t edit.
​
string
Signed snippets only. The embed key version. Changes when you rotate the embed key.
​
string
Signed snippets only. Signature over the widget ID, domain and key version.

​
Iframe attributes

​
Hosts

Snippets use https://iframe.polyembed.io. Older snippets that point at https://polyembed.io/embed/… keep working; you don’t need to change them. If you do switch, update the iframe src and keep the listener script as is: it reads the origin from the iframe’s src.

​
Behavior

The embed page is served with frame-ancestors * so it can be framed by any site, and with noindex so search engines rank your article rather than the widget.