Documentation Index
Fetch the complete documentation index at: https://sitegpt.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
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
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
--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.
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
- 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
- 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
| Type | Use |
|---|
bot | Avatar for AI messages. |
person | Fallback visitor/user avatar. |
agent | Fallback human-agent avatar. |
watermark | Watermark image when enabled. |
chat-bubble | Launcher bubble image. |
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.
Recommended setup order
For a new chatbot, use this order:
Create the chatbot
sitegpt chatbots create "Brand Support" --description "Answers questions about Brand." --json
Add knowledge
Prefer sitemap, then website crawl, then selected links.
Configure persona and instructions
Use sitegpt personas and sitegpt instructions.
Apply appearance, starters, and followups
Use sitegpt settings appearance, sitegpt icons, sitegpt starters, and sitegpt followups.
Verify
sitegpt dashboard --chatbot <chatbot-id>
sitegpt messages send --chatbot <chatbot-id> "What can you help with?"
Full reference
