---
title: "Get the widget settings (public)"
method: GET
path: "/public/config"
tags: ["Chat widget"]
---

# Get the widget settings (public)

`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`

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.

## Response `200`

The settings of the widget.

- PublicChatConfig: What the chat widget needs before a conversation starts.
  - `name` string, required: The name of the project, as the widget shows it.
  - `greeting` string, required: The fixed greeting, in the language the assistant opens in.
  - `language` string, required: The language the assistant opens in (nl, en, de, fr or es).
  - `languages` string[], required: The languages of the assistant.
  - `mode` 'live' | 'test', required: live or test, from the token.
  - `turnstile` boolean, required: Whether POST /public/conversations needs a turnstile_token.
  - `max_message_length` integer, required: The longest message a visitor can send, in characters.
  - `max_turns` integer, required: After this many turns the conversation closes.

## Other responses

- `401`: Unauthorized: invalid_chat_token, chat_token_revoked.
- `403`: Forbidden: origin_not_allowed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: chat_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)