Skip to main content
Use these commands to create a chatbot, get its embed code, check how it is doing, and transfer or delete it. Most other CLI commands need the chatbot ID, so start with Find your chatbot ID. For every option of every command, see the command reference.

​
Before you start

  • The Growth plan or above, on your own account or on the account that owns the chatbot. See Which plan applies. To create a chatbot, your own plan must be Growth or above.
  • The CLI installed and logged in. See Install and log in.
  • The default access from sitegpt login is enough for the tasks on this page. Your role on the chatbot must also allow the action. See Authentication.

​
Find your chatbot ID

List your chatbots:
To save the ID of the first chatbot in a shell variable, use JSON output and jq:
Check that it works: Run sitegpt chatbots get YOUR_CHATBOT_ID. The output shows the chatbot title, the ID, and the owner email.

​
Create a chatbot

You can also pass the title with --title "Support Bot". Add --json to get the new ID in JSON. Check that it works: The CLI prints Created chatbot Support Bot (ID). The new chatbot shows in sitegpt chatbots list. Next, add content to the chatbot. See Manage content.

​
Rename a chatbot or change its description

You can pass --title, --description, or both. Check that it works: The CLI prints Updated chatbot Help Center Bot (ID).

​
Get the embed code

The output has the chat link, the widget script URL, and the embed code. To add the embed code to your website, see Add the chatbot to your website. Check that it works: Open the chat link in a browser. The chatbot opens and answers a test question. If the chatbot has Allowed Domains, the chat link shows “This chat opens on its website” when you open it directly. Test on your website, or select Chat with your chatbot on the chatbot’s Dashboard page.

​
Check training and feedback

Get a summary of one chatbot:
The summary shows:
  • The training state
  • The total, trained, pending, and failed document counts
  • The link, file, and page counts
  • A summary of conversation feedback
  • The chat link and the widget script URL
Check that it works: The Documents line shows 0 failed. If it does not, see Resync content.

​
See engagement analytics

The output shows totals for the range, such as widget opens, conversations started, unique visitors, escalations, and leads. It compares them with the previous period. Add --json to also get the daily series.
  • Dates are UTC days in the format YYYY-MM-DD.
  • If you leave out --start and --end, the range is the last 30 days.
  • Your plan must include analytics. If it does not, the command fails with 403 and the code ANALYTICS_LOCKED.
  • Insight counters show only when your plan includes insights.
See Plans and limits. Check that it works: The first line shows the range that you asked for, for example Range: 2026-08-01 to 2026-08-19 (UTC).

​
Transfer a chatbot

Only a Super Admin of the chatbot can transfer it. The owner is always a Super Admin. The token needs the chatbots:write, members:write, and members:delete scopes. The command asks for the transfer. The chatbot moves only when the new owner accepts. For the whole flow, see Transfer a chatbot to another owner.
  • SiteGPT emails the new owner. They accept or decline on the Chatbots page of the dashboard, under Pending Transfers, or with API v2. The CLI has no command to accept.
  • SiteGPT does not create an account for the new owner. They sign in with the email address that you used.
  • The request stays open for 7 days. A chatbot has one open request. Running the command again replaces it.
  • When the new owner accepts, they become a Super Admin of the chatbot. By default, SiteGPT then removes the previous owner from the chatbot.
  • To keep the previous owner as a team member, add --keep-source-as with a role: AGENT, MANAGER, ADMIN, or SUPER_ADMIN. This adds a team member, so it counts toward the member limit. SiteGPT checks for a free seat when you send the request and again when the new owner accepts.
  • To use a user ID instead of an email, pass --user-id YOUR_USER_ID.
Use CLI 0.7.0 or later. CLI 0.6.1 and earlier send the request and the email, and then print an error such as Cannot read properties of undefined (reading 'previousOwnerRemoved'), because they expect the answer of the old transfer. The request was still made. Do not run the command again to fix this error, because a new request replaces the first one and sends a second email. Update the CLI with npm install -g @sitegpt/cli.
Check that it works: The CLI prints Transfer of chatbot, the title, the ID, and sent to with the new owner’s email address. It then says what happens to the previous owner when the new owner accepts, and when the request expires. It adds replacing the open one when the command replaced an open request. With --json, data.transfer.status is pending, and data.replacedPendingTransfer is true when the command replaced an open request. To check or cancel the request, use API v2. See Check or cancel the request.

​
Delete a chatbot

This deletes the chatbot. The command needs --yes to confirm.
Check that it works: The CLI prints Deleted chatbot, the title, and the ID. The chatbot is no longer in sitegpt chatbots list.