Chat widget

Get the widget settings (public)

Called by the chat widget in the visitor's browser, with the public chat token in ?token= and the Origin header of the page. No API key. Returns what the widget shows before a conversation starts: the project name, the greeting, the language and whether a bot check is needed. Every /public route allows CORS only for an allowed origin (with an OPTIONS preflight), and any reason that concerns you rather than the visitor (balance, verification, the daily spending limit) returns 503 chat_unavailable, without details; the real reason is in the portal. All /public requests combined: at most 60 per minute per IP address.

get/public/config

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/public/config
  • Auth: API key in query parameter token

Response

The settings of the widget.

namestring required

The name of the project, as the widget shows it.

greetingstring required

The fixed greeting, in the language the assistant opens in.

languagestring required

The language the assistant opens in (nl, en, de, fr or es).

languagesstring[] required

The languages of the assistant.

mode'live' | 'test' required

live or test, from the token.

turnstileboolean required

Whether POST /public/conversations needs a turnstile_token.

max_message_lengthinteger required

The longest message a visitor can send, in characters.

max_turnsinteger required

After this many turns the conversation closes.

Changes

No recorded changes to this operation across all 1 revision of this API.