Customization - SiteGPT Docs

Customization commands control how a chatbot sounds, behaves, appears, and guides conversations.

Personas

Personas describe the chatbot’s role, tone, and identity. They are separate from instructions and settings.

sitegpt personas list --chatbot <chatbot-id>
sitegpt personas get --chatbot <chatbot-id> <persona-id>
sitegpt personas add --chatbot <chatbot-id> --title "Support specialist" --instructions "You are a helpful support assistant."
sitegpt personas add --chatbot <chatbot-id> --title "Support specialist" --description "Friendly support persona" --file ./persona.md
sitegpt personas update --chatbot <chatbot-id> <persona-id> --title "New title"
sitegpt personas update --chatbot <chatbot-id> <persona-id> --file ./persona.md
sitegpt personas use --chatbot <chatbot-id> <persona-id>
sitegpt personas delete --chatbot <chatbot-id> <persona-id> --yes

Options:

Option	Description
`--title <title>`	Persona title. Required when adding.
`--description <description>`	Optional description.
`--instructions <text>`	Persona instructions.
`--file <path>`	Read persona instructions from a local file.

personas create is an alias for personas add.

Instructions

Instructions control response behavior, grounding, safety rules, and model temperature.

sitegpt instructions list --chatbot <chatbot-id>
sitegpt instructions get --chatbot <chatbot-id> <instruction-id>
sitegpt instructions add --chatbot <chatbot-id> --instructions "Answer only from the provided knowledge."
sitegpt instructions add --chatbot <chatbot-id> --file ./instructions.md --temperature 0.3
sitegpt instructions update --chatbot <chatbot-id> <instruction-id> --temperature 0.5
sitegpt instructions update --chatbot <chatbot-id> <instruction-id> --file ./instructions.md
sitegpt instructions use --chatbot <chatbot-id> <instruction-id>
sitegpt instructions delete --chatbot <chatbot-id> <instruction-id> --yes

Options:

Option	Description
`--title <title>`	Optional title.
`--instructions <text>`	Instruction text.
`--file <path>`	Read instructions from a local file.
`--temperature <0-1>`	Model temperature. Default for add: `0.5`.

instructions create is an alias for instructions add.

Settings

Read all settings:

sitegpt settings get --chatbot <chatbot-id>
sitegpt settings get --chatbot <chatbot-id> --json

Update all settings from a JSON file:

sitegpt settings update --chatbot <chatbot-id> --file ./settings.json

Read one section:

sitegpt settings general get --chatbot <chatbot-id>
sitegpt settings appearance get --chatbot <chatbot-id>
sitegpt settings chat-mode get --chatbot <chatbot-id>

For section updates, set is accepted as an alias for update:

sitegpt settings general set --chatbot <chatbot-id> --support-email support@example.com
sitegpt settings appearance set --chatbot <chatbot-id> --brand-color "#155DEE"

Supported sections:

general, appearance, chat-mode, localization, advanced, user-data, lead-form, human-support, webhooks

Section aliases also accept camelCase names such as chatMode, leadForm, humanSupport, and userData.

General settings

sitegpt settings general update --chatbot <chatbot-id> --support-email support@example.com
sitegpt settings general update --chatbot <chatbot-id> --description "Answers docs and support questions."
sitegpt settings general update --chatbot <chatbot-id> --history-count 8
sitegpt settings general update --chatbot <chatbot-id> --model gpt-4

Fields:

Option	Values/default
`--file <section.json>`	Merge JSON file with flag updates.
`--description <text>`	Chatbot description.
`--support-email <email>`	Support email.
`--disable-smart-follow-ups <boolean>`	Default: `false`.
`--smart-follow-up-count <1-5>`	Default: `3`.
`--disable-lead-notifications <boolean>`	Default: `false`.
`--page-context <boolean>`	Default: `false`.
`--history-count <0-50>`	Default: `1`.
`--model <model>`	`gpt-3.5-turbo` or `gpt-4`. Default: `gpt-3.5-turbo`.
`--rate-limit-thread-enabled <boolean>`	Default: `false`.
`--rate-limit-thread-max-messages <1-1000>`	Maximum messages per thread when enabled.

Appearance settings

sitegpt settings appearance update --chatbot <chatbot-id> --brand-color "#155DEE"
sitegpt settings appearance update --chatbot <chatbot-id> --brand-text-color "#FFFFFF" --link-color "#155DEE"
sitegpt settings appearance update --chatbot <chatbot-id> --icon-shape CIRCLE --icon-position RIGHT --icon-size MEDIUM
sitegpt settings appearance update --chatbot <chatbot-id> --welcome "Hi! How can I help?"

Common fields:

Option	Description
`--title <title>`	Widget title.
`--tooltip <text>`	Launcher tooltip.
`--welcome <message>`	Welcome message.
`--placeholder <text>`	Input placeholder.
`--brand-color <color>`	Primary brand color.
`--brand-text-color <color>`	Text color on brand background.
`--icon-background-color <color>`	Launcher icon background.
`--link-color <color>`	Link color.
`--icon-background-transparent <boolean>`	Transparent launcher background.
`--hide-sources <boolean>`	Hide answer source links.
`--hide-tooltip <boolean>`	Hide launcher tooltip.
`--hide-watermark <boolean>`	Hide watermark.
`--hide-feedback-buttons <boolean>`	Hide feedback buttons.
`--dark-mode <boolean>`	Enable dark mode.
`--rtl <boolean>`	Enable right-to-left layout.

More appearance fields:

Option	Values/default
`--icon-size <size>`	`SMALL`, `MEDIUM`, `LARGE`, `XL`, `2XL`, `3XL`, `4XL`, `5XL`. Default: `SMALL`.
`--icon-position <position>`	`LEFT` or `RIGHT`. Default: `RIGHT`.
`--icon-shape <shape>`	`CIRCLE` or `SQUARE`. Default: `CIRCLE`.
`--desktop-auto-open <mode>`	`ALWAYS_OPEN_WITH_DELAY` or `DONT_OPEN`. Default: `DONT_OPEN`.
`--mobile-auto-open <mode>`	`ALWAYS_OPEN_WITH_DELAY` or `DONT_OPEN`. Default: `DONT_OPEN`.
`--desktop-open-delay <seconds>`	Default: `0`.
`--mobile-open-delay <seconds>`	Default: `0`.
`--distance-bottom <number>`	Default: `16`.
`--mobile-distance-bottom <number>`	Mobile bottom distance.
`--horizontal-distance <number>`	Default: `16`.
`--mobile-horizontal-distance <number>`	Mobile horizontal distance.
`--font-size <8-32>`	Default: `16`.
`--height <1-100>`	Default: `85`.
`--terms-text <text>`	Terms acceptance text.
`--disclaimer <text>`	Disclaimer text.
`--watermark-text <text>`	Watermark text.
`--watermark-link <url>`	Watermark URL.
`--cta-text <text>`	CTA text.
`--cta-link <url>`	CTA URL.
`--external-link-url <url>`	External link URL.
`--learn-more <text>`	Learn-more copy.

Chat mode

sitegpt settings chat-mode get --chatbot <chatbot-id>
sitegpt settings chat-mode set --chatbot <chatbot-id> AI
sitegpt settings chat-mode set --chatbot <chatbot-id> AGENT

Modes:

Mode	Description
`AI`	Chatbot answers automatically. Default.
`AGENT`	Human/agent mode.

Advanced settings

sitegpt settings advanced update --chatbot <chatbot-id> --top-k 6
sitegpt settings advanced update --chatbot <chatbot-id> --css-selector ".cookie-banner" --css-selector "nav"

Fields:

Option	Description
`--file <section.json>`	Merge JSON file with flag updates.
`--top-k <1-50>`	Retrieval top K. Default: `4`.
`--css-selector <selector>`	Selector to remove. Repeatable.

User data settings

sitegpt settings user-data update --chatbot <chatbot-id> --collect OPTIONAL
sitegpt settings user-data update --chatbot <chatbot-id> --collect-name true --collect-phone false

Fields:

Option	Values/default
`--collect <mode>`	`MANDATORY`, `OPTIONAL`, `DO_NOT_COLLECT`. Default: `OPTIONAL`.
`--collect-name <boolean>`	Default: `false`.
`--collect-phone <boolean>`	Default: `false`.

Lead form settings

sitegpt settings lead-form update --chatbot <chatbot-id> --enabled true --collect-name true
sitegpt settings lead-form update --chatbot <chatbot-id> --trigger unable_to_answer --notification-email sales@example.com

Fields:

Option	Values/default
`--enabled <boolean>`	Enable lead collection. Default: `false`.
`--collect-name <boolean>`	Default: `false`.
`--collect-phone <boolean>`	Default: `false`.
`--industry-template <template>`	`custom`, `dental`, `hvac`, `legal`, `real_estate`, `automotive`, `healthcare`, `saas`, `ecommerce`, `consulting`. Default: `custom`.
`--trigger <trigger>`	`intent`, `unable_to_answer`, `after_x_messages`. Default: `intent`.
`--custom-keywords <text>`	Keywords for custom trigger behavior.
`--message-count <1-20>`	Default: `1`.
`--booking-enabled <boolean>`	Default: `false`.
`--booking-link <url>`	Booking URL.
`--escalate <boolean>`	Escalate after lead collection. Default: `false`.
`--notifications-enabled <boolean>`	Default: `true`.
`--notification-email <email>`	Repeatable.

Human support settings

sitegpt settings human-support update --chatbot <chatbot-id> --enabled true
sitegpt settings human-support update --chatbot <chatbot-id> --request-prompt "Would you like to talk to a person?"
sitegpt settings human-support update --chatbot <chatbot-id> --notification-email support@example.com

Fields include --enabled, --positive-prompt, --request-prompt, --confirmation, --show-buttons, --replace-suggestions, --notifications-enabled, repeated --notification-email, --new-conversation-notifications-enabled, and repeated --new-conversation-email.

Localization and webhooks

Localization updates are JSON-file based:

sitegpt settings localization get --chatbot <chatbot-id>
sitegpt settings localization update --chatbot <chatbot-id> --file ./localization.json

Webhook fields:

sitegpt settings webhooks update --chatbot <chatbot-id> --message-url https://example.com/message-webhook
sitegpt settings webhooks update --chatbot <chatbot-id> --message-token <token>
sitegpt settings webhooks update --chatbot <chatbot-id> --escalation-url https://example.com/escalation-webhook
sitegpt settings webhooks update --chatbot <chatbot-id> --escalation-token <token>
sitegpt settings webhooks update --chatbot <chatbot-id> --leads-url https://example.com/leads-webhook
sitegpt settings webhooks update --chatbot <chatbot-id> --leads-token <token>

Conversation starters

Starters are buttons shown before the visitor sends a message.

sitegpt starters list --chatbot <chatbot-id>
sitegpt starters get --chatbot <chatbot-id> <starter-id>
sitegpt starters add --chatbot <chatbot-id> --title "Pricing" --message "Tell me about pricing."
sitegpt starters update --chatbot <chatbot-id> <starter-id> --title "New title"
sitegpt starters delete --chatbot <chatbot-id> <starter-id> --yes
sitegpt starters reorder --chatbot <chatbot-id> <id1> <id2>

starters create is an alias for starters add.

Conversation followups

Followups are prompt buttons shown after chatbot responses.

sitegpt followups list --chatbot <chatbot-id>
sitegpt followups get --chatbot <chatbot-id> <followup-id>
sitegpt followups add --chatbot <chatbot-id> --title "Contact support" --message "How can I contact support?"
sitegpt followups add --chatbot <chatbot-id> --title "Open docs" --link https://example.com/docs --type LINK
sitegpt followups add --chatbot <chatbot-id> --title "Talk to support" --escalation
sitegpt followups update --chatbot <chatbot-id> <followup-id> --title "New title"
sitegpt followups delete --chatbot <chatbot-id> <followup-id> --yes
sitegpt followups reorder --chatbot <chatbot-id> <id1> <id2>

Prompt button fields:

Option	Description
`--title <title>`	Button title.
`--message <message>`	Prompt message or description.
`--description <message>`	Alias-style message input.
`--link <url>`	Link target. Implies `LINK` type.
`--type <type>`	`PROMPT`, `LINK`, `ESCALATION`. Default: `PROMPT`; `--link` implies `LINK`.
`--escalation`	Followups only. Creates an escalation prompt.

​Personas

​Instructions

​Settings

​General settings

​Appearance settings

​Chat mode

​Advanced settings

​User data settings

​Lead form settings

​Human support settings

​Localization and webhooks

​Conversation starters

​Conversation followups

​Full reference

Personas

Instructions

Settings

General settings

Appearance settings

Chat mode

Advanced settings

User data settings

Lead form settings

Human support settings

Localization and webhooks

Conversation starters

Conversation followups

Full reference