Widget endpoints

Get the chat snippet for any framework and lock the chat to your domains.

For customers only. This channel serves the customers of the business (questions, sales, bookings) with your Brain, products and services. It is never an interface for the owner: it does not change settings, read Activities or take orders from the owner, even if someone says they are the owner. The owner talks to ORYKSA only in the official ORYKSA app, the dashboard and the browser extension. More

Snippet

framework: html, nextjs-app, nextjs-pages, react, vue, nuxt, astro, svelte, angular or wordpress. Optional lang and position (left or right). The answer says where to paste the code.

curl "https://api.oryksa.com/v1/widget?framework=nextjs-app&lang=en" -H "Authorization: Bearer oryk_live_YOUR_KEY"

{
  "object": "widget",
  "where": "app/layout.tsx: import Script from 'next/script' and add inside <body>.",
  "code": "<Script src=\"https://app.oryksa.com/static/oryksa-widget.js\" data-token=\"...\" data-lang=\"en\" strategy=\"afterInteractive\" />",
  "widget_token": "af66ff5ce932faf7b16f1dea324700f6",
  "voice_replies": true,
  "note": "The widget token is public by design (it only lets visitors chat)."
}

Allowed domains

Up to 20 domains; subdomains are included. An empty list removes the restriction.

curl -X PUT https://api.oryksa.com/v1/widget/domains \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domains": ["quintadovale.pt"]}'