Widget and secret keys

The two kinds of ASE keys: public widget keys that go in your HTML and are locked to a domain, and private secret keys for server-to-server calls.

Widget key

A widget key (pk_…) connects the widget on a page to one agent on one domain. It is public by design: it sits in your HTML. Protection comes from the domain lock: requests that carry the key from any other website are refused with "Domain mismatch".

  • Create under Keys & Embed → Widget Keys → + New: choose domain and agent.
  • Create several keys if you run different agents on different subdomains or pages.
  • Regenerate gives the key a new value; update the snippet on your site afterwards. Revoke disables it; pages still carrying it show no widget.
  • Limits: Free 1, Basic 3, Standard 6, Pro 10.

Secret key

A secret key is private and used from your server, never from a browser: CMS extensions and custom integrations use it to call the API on behalf of your workspace.

  • Create under Keys & Embed → Secret Keys: choose the domain, add a label. The key is shown once; copy it immediately.
  • Keep it in your server configuration, not in HTML or JavaScript. If it leaks, revoke it and create a new one.
  • Limits: Free 1, Basic 1, Standard 2, Pro 3.

Which key does what

Widget keySecret key
Where it livesYour HTMLYour server
Sent asdata-key on the script tag; X-Widget-Key headerX-Secret-Key header
Bound toOne domain and one agentOne domain
Safe to exposeYesNo