Skip to main content
Chatbots are the central SiteGPT resource. Most knowledge, settings, conversations, members, and lead commands need a chatbot ID.

​
List chatbots

sitegpt chatbots list
sitegpt chatbots list --json
Use JSON when you need the chatbot ID for follow-up commands: 
CHATBOT_ID=$(sitegpt chatbots list --json | jq -r '.data.chatbots[0].id')

​
Get one chatbot

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

​
Create a chatbot

sitegpt chatbots create "Support Bot"
sitegpt chatbots create "Support Bot" --description "Answers customer support questions"
sitegpt chatbots create --title "Support Bot" --description "Answers customer support questions" --json
The title can be positional or passed as --title.

​
Update a chatbot

sitegpt chatbots update <chatbot-id> --title "New chatbot name"
sitegpt chatbots update <chatbot-id> --description "New description"
sitegpt chatbots update <chatbot-id> --title "New name" --description "New description"

​
Delete a chatbot

sitegpt chatbots delete <chatbot-id> --yes
--yes is required because deletion is destructive.

​
Transfer a chatbot

Reassign a chatbot’s ownership to another user in the same brand. If the recipient does not have a SiteGPT account yet, one is provisioned for them. 
# Hand-off: ownership moves and the previous owner is removed from the chatbot
sitegpt chatbots transfer <chatbot-id> --email new-owner@example.com

# Reassign within a team: the previous owner stays on as a member at this role
sitegpt chatbots transfer <chatbot-id> --email teammate@example.com --keep-source-as ADMIN

# By user id instead of email
sitegpt chatbots transfer <chatbot-id> --user-id <user-id> --json
By default the previous owner is removed from the chatbot. Pass --keep-source-as <AGENT|MANAGER|ADMIN|SUPER_ADMIN> to keep them as a member instead (ownership reassignment within a team). Only a chatbot super admin can transfer it — the creator/owner is always a super admin.

​
Dashboard summary

Use dashboard to fetch an operational summary for one chatbot: 
sitegpt dashboard --chatbot <chatbot-id>
sitegpt dashboard show --chatbot <chatbot-id>
sitegpt dashboard get --chatbot <chatbot-id> --json
The response includes:
  • Training state
  • Total, trained, pending, and failed document counts
  • Link, file, custom response, and page counts
  • Conversation feedback summary
  • Chat URL
  • Widget script URL

​
Installation snippet

Get safe installation metadata and the embeddable script snippet: 
sitegpt installation snippet --chatbot <chatbot-id>
sitegpt installation snippet --chatbot <chatbot-id> --json
The command returns:
  • Chat URL
  • Widget script URL
  • Embed code

​
Upload chatbot icons

Icon commands upload local image files. Download remote assets first, then upload the local file path. 
sitegpt icons upload --chatbot <chatbot-id> bot ./bot.png
sitegpt icons upload --chatbot <chatbot-id> person ./person.png
sitegpt icons upload --chatbot <chatbot-id> agent ./agent.png
sitegpt icons upload --chatbot <chatbot-id> watermark ./watermark.png
sitegpt icons upload --chatbot <chatbot-id> chat-bubble ./bubble.png
Supported icon types:
TypeUse
botAvatar for AI messages.
personFallback visitor/user avatar.
agentFallback human-agent avatar.
watermarkWatermark image when enabled.
chat-bubbleLauncher bubble image.
Supported image files: 
png, jpg, jpeg, webp, gif, avif, svg

​
Delete chatbot icons

sitegpt icons delete --chatbot <chatbot-id> bot --yes
sitegpt icons remove --chatbot <chatbot-id> chat-bubble --yes
remove is an alias for delete. For a new chatbot, use this order:
1

Create the chatbot

sitegpt chatbots create "Brand Support" --description "Answers questions about Brand." --json
2

Add knowledge

Prefer sitemap, then website crawl, then selected links.
3

Configure persona and instructions

Use sitegpt personas and sitegpt instructions.
4

Apply appearance, starters, and followups

Use sitegpt settings appearance, sitegpt icons, sitegpt starters, and sitegpt followups.
5

Verify

sitegpt dashboard --chatbot <chatbot-id>
sitegpt messages send --chatbot <chatbot-id> "What can you help with?"

​
Full reference