Embed API reference
The public embed API powers Hark’s chat widget and customer portal. Every endpoint lives under /api/embed/{publicKey}, where the public key is the widget’s only credential. It ships in the loader script on your own site, so it is safe to expose. Expand any endpoint below to see its parameters and examples, then send a live request right from this page.
The explorer is prefilled with a demo widget public key (cmrpblh3600bbxnooccut6yqc), so read endpoints return live data straight away. Requests run from your browser to the same origin, so there is no setup and no CORS. Endpoints that write data are labelled; they post to the demo workspace only.
Widget loader
The single script tag that installs the chat widget on any site. Returns JavaScript, not JSON.
AI chat
Send a message to the widget’s AI and get an answer grounded in the content the org has allowed.
Conversations
Open a conversation, read and send messages, ask for a human, and check where a conversation stands.
Chat flows
List the widget’s published flows and run one step by step. The flow tree stays on the server.
Help home
The self-serve home surface: search the help center, list suggested articles, and rate an answer.
Feedback boards
Read public feedback boards and their posts, submit a request, and upvote.
Roadmap
Read the public roadmap and follow or unfollow a roadmap item for updates.
Changelog
Read published changelog entries and subscribe an email for what’s new.
Status page
The org’s public component health and any active or recently resolved incidents.
25 public endpoints across the widget, chat, conversations, flows, help home, feedback, roadmap, changelog, and status surfaces.