Widget Configuration

Läs och uppdatera webbplatswidgetens konfiguration via API:et.

Widgeten är ett chattgränssnitt som du bäddar in på din webbplats — den visas som en flytande bubbla i hörnet av sidan som besökare kan klicka på för att öppna en konversation med din AI Agent. Widgeten är helt anpassningsbar: du styr dess färger, storlek, placering, hälsningsmeddelanden och beteende.

Dessa inställningar påverkar även embedden, som är en helsides- eller inline-version av samma chattgränssnitt som du kan placera direkt i din webbsideslayout (i stället för den flytande bubblan). Både widgeten och embedden delar samma konfiguration för utseende, meddelanden och beteende.

Med dessa endpoints kan du programmatiskt anpassa hur Quickchat AI visas på din webbplats — matcha dina varumärkesfärger, ställa in formulär före chatten för att samla in besökarinformation, konfigurera skrivindikatorer, aktivera röstinmatning med mera. För installationsinstruktioner, se guiden för Website-kanalen.

Scope: read_all

GET https://app.quickchat.ai/v1/api/widget/configuration

Shell
Python

curl https://app.quickchat.ai/v1/api/widget/configuration \
  -H 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/widget/configuration",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "welcome_message": "<p>Hello! How can I help?</p>",
  "welcome_message2": "",
  "header": "Support",
  "subtitle": "We typically reply within minutes",
  "conversation_starters": ["What are your opening hours?", "How do I track my order?", "Talk to a human"],
  "popup_active": true,
  "input_placeholder": "Type your message...",
  "primary_color": "rgb(0, 122, 255)",
  "voice_active": false,
  "header_color": "rgb(0, 122, 255)",
  "header_collapse": false,
  "header_text_color": true,
  "typing": true,
  "window_auto_open": false,
  "white_label": false,
  "prechat_active": false,
  "prechat_header_text": null,
  "prechat_button_text": null,
  "prechat_message_text": null,
  "background_disclaimer_text": null,
  "streaming_active": true,
  "link_tracking_active": false,
  "window_height": 600,
  "window_width": 400,
  "size": "medium",
  "location": "bottom-right",
  "launcher_label": "Ask AI",
  "launcher_draggable": false,
  "avatar_image": "https://storage.googleapis.com/quickchat-files/appquickchat/media/chat_avatars/default_bubble.png",
  "bubble_icon_image": "https://storage.googleapis.com/quickchat-files/appquickchat/media/chat_avatars/default_bubble.png",
  "default_avatar_image": "https://storage.googleapis.com/quickchat-files/appquickchat/media/chat_avatars/default_bubble.png",
  "theme": "light",
  "widget_theme_custom": {
    "colors": {
      "background": "#ffffff",
      "header": "#ffffff",
      "header_text": "#030712",
      "accent": "#27272a",
      "accent_hover": "#374151",
      "accent_text": "#ffffff",
      "bubble": "#27272a",
      "bubble_text": "#ffffff",
      "ai_bubble_text": "#030712",
      "tertiary": "#afafb2",
      "link": null,
      "input_background": "#ffffff",
      "input_text": "#030712",
      "input_placeholder": "#9ca3af",
      "border": "#e5e7eb",
      "sidebar": {
        "background": "#f5f5f5",
        "text": null,
        "accent": "#e5e5e5",
        "accent_text": null
      }
    },
    "radius": { "bubble": "full", "input": "full", "button": "full" },
    "font": { "size": "base" }
  }
}

Content & Messaging

Field	Description
`welcome_message` string	Primärt välkomstmeddelande som visas när widgeten öppnas (HTML). Dashboard: Website > Greeting
`welcome_message2` string	Sekundärt välkomstmeddelande som visas under den primära hälsningen
`header` string	Text som visas i widgetens header-rad. Dashboard: Website > Header
`subtitle` string	Underrubrikstext som visas under headern. Dashboard: Website > Subtitle
`input_placeholder` string	Platshållartext i meddelandeinmatningsfältet (t.ex. “Type your message…”)
`conversation_starters` array of strings or null	Föreslagna inledande prompts som visas som klickbara knappar när widgeten öppnas. Upp till 3 poster, var och en upp till ca 100 tecken
`background_disclaimer_text` string or null	Ansvarsfriskrivningstext som visas längst ned i chattfönstret

Appearance

Field	Description
`primary_color` string	Widgetens accentfärg som CSS rgb-värde (t.ex. `"rgb(0, 122, 255)"`). Används för knappar, länkar och användarens meddelandebubblor
`header_color` string	Headerns bakgrundsfärg som CSS rgb-värde
`header_text_color` boolean	Headertextens ljusstyrka. `true` = vit/ljus text (för mörka headers), `false` = mörk text (för ljusa headers). Obs: trots namnet är detta en boolean, inte en färgsträng
`size` string	Förinställd storlek på launcher: `"small"`, `"medium"` eller `"large"` (visas i dashboarden som Small, Input Only och Classic)
`location` string	Widgetens placering på sidan: `"top-left"`, `"top-right"`, `"bottom-left"` eller `"bottom-right"`
`launcher_label` string or null	Text på den lilla launcher-knappen (`size: "small"`), max 25 tecken. `null` använder standardvärdet (`"Ask AI"`); `""` visar en launcher med endast ikon
`launcher_draggable` boolean	Låt besökare dra launchern till en annan plats på sidan
`window_height` integer	Widgetens höjd i pixlar (400-1200)
`window_width` integer	Widgetens bredd i pixlar (300-700)
`avatar_image` string or null	URL till AI Agent Avatar, som visas både i chattens header och som ikonen på den flytande bubblan. Ladda upp via PATCH som base64. `null` betyder att avataren togs bort och widgeten visar ingen avatar
`bubble_icon_image` string or null	Föråldrad. Speglar alltid `avatar_image` — bubbelikonen och chattavataren är nu en och samma bild (se Sammanslagning av AI Agent Avatar)
`default_avatar_image` string	Skrivskyddad. URL till den standard-AI Agent Avatar som `use_default_avatar` återställer
`theme` string	Färgtemaläge: `"light"` eller `"dark"` (fasta förinställningar) eller `"custom"` (tillämpar paletten `widget_theme_custom`)
`widget_theme_custom` object	Anpassad palett som tillämpas när `theme` är `"custom"`. Innehåller `colors` (header, accent, meddelandebubbla, AI-text, `link`, input, border med mera, som hex eller `rgb()`/`rgba()`), `radius` (`"sm"`/`"base"`/`"lg"`/`"full"` för bubblor, input och knappar) och `font.size` (`"sm"`/`"base"`/`"lg"`). Vid PATCH, skicka hela objektet — saknade nycklar återställs till standardvärden. `colors.link` är som standard `null`, vilket innebär att länkar ärver färgen från den omgivande texten. `colors.sidebar` (`background`, `text`, `accent`, `accent_text`) styr endast temat för den fristående Chat Page-sidebaren (ignoreras av bubbel- och embed-vyerna); dess `text` och `accent_text` är som standard `null`, vilket innebär att en läsbar färg härleds automatiskt från den matchande bakgrunden

Behavior

Field	Description
`popup_active` boolean	Visa en popup-prompt nära widgetbubblan för att uppmuntra besökare att starta en konversation
`window_auto_open` boolean	Öppna widgeten automatiskt när sidan laddas (i stället för att bara visa bubblan)
`header_collapse` boolean	Låt besökare fälla ihop headerområdet för mer chattutrymme
`typing` boolean	Visa en skrivindikatoranimering medan AI:n genererar ett svar
`streaming_active` boolean	Strömma AI-svar ord för ord i stället för att visa hela meddelandet på en gång
`voice_active` boolean	Aktivera röstinmatning — besökare kan skicka meddelanden med sin mikrofon
`link_tracking_active` boolean	Spåra när besökare klickar på länkar i AI-svar. Spårade klick visas som `tracked_link`-händelser i Conversation Events
`white_label` boolean	Ta bort “Powered by Quickchat”-varumärket från widgeten

Pre-chat Form

Field	Description
`prechat_active` boolean	Aktivera formuläret före chatten. När det är aktivt måste besökare fylla i formuläret innan de kan chatta
`prechat_header_text` string or null	Headertext för formuläret före chatten
`prechat_button_text` string or null	Etikett för skicka-knappen i formuläret före chatten
`prechat_message_text` string or null	Brödtext/instruktioner som visas i formuläret före chatten (HTML)

Scope: write_all

PATCH https://app.quickchat.ai/v1/api/widget/configuration

Request Body — Alla fält är valfria. Inkludera bara de fält du vill uppdatera.

Sammanslagning av AI Agent Avatar

Chattavataren (header-logotypen) och ikonen på den flytande bubblan (launchern) slogs samman till en enda bild, AI Agent Avatar, som lagras i avatar_image. Bubbelikonen speglar den alltid — det finns inte längre någon fristående launcher-bild. Om du integrerar direkt mot denna endpoint, notera följande beteendeändringar:

Att ladda upp via bubble_icon_image är föråldrat: det sätter nu den sammanslagna AI Agent Avatar, vilket även ersätter bilden som visas i chattens header. Använd avatar_image i stället.
bubble_icon_image: null är en no-op. Det brukade rensa launcher-ikonen; eftersom launchern speglar avataren, ta bort via avatar_image: null i stället.
Agenter som aldrig anpassat sin avatar visar standard-AI Agent Avatar (se default_avatar_image i svaret) i både headern och launchern.

Shell
Python

curl -X PATCH https://app.quickchat.ai/v1/api/widget/configuration \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "primary_color": "rgb(255, 87, 34)",
  "header": "Sales Assistant",
  "window_auto_open": true
}'

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/widget/configuration",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "primary_color": "rgb(255, 87, 34)",
        "header": "Sales Assistant",
        "window_auto_open": True,
    },
)
data = response.json()

Response 200 OK — Returnerar den uppdaterade widgetkonfigurationen (samma schema som svaret för Get Widget Configuration).

Widget Configuration