Command reference - SiteGPT Docs

This page is the complete CLI reference. It is organized by entity so humans and AI agents can quickly find the exact command surface for the thing they want to manage. For workflow guidance, use the task pages:

How to read this reference

The installed command is:

sitegpt

Every command level has contextual help:

sitegpt --help
sitegpt knowledge --help
sitegpt knowledge documents --help
sitegpt settings appearance --help

Use --json whenever you need full IDs, cursors, nested data, or automation-safe output.

Global options

Global options can be used with any command.

Option	Description
`--json`	Print machine-readable JSON instead of human table/text output.
`--profile <name>`	Use a saved local profile for this command.
`-p <name>`	Alias for `--profile`.
`--api-base <url>`	Override the SiteGPT API base URL for this command.
`-h`, `--help`	Show contextual help for the current command level.
`-v`, `--version`	Print the installed CLI version.

Environment variable overrides:

Variable	Description
`SITEGPT_API_TOKEN`	Use this token for the current command. Overrides saved profile token.
`SITEGPT_API_BASE`	Use this API base URL for the current command.
`SITEGPT_PROFILE`	Use this profile for the current command.

Local profiles are stored at:

~/.config/sitegpt/config.json

Command	Description
`sitegpt login`	Start browser approval login with standard CLI access.
`sitegpt login --full-access`	Request every self-service scope your dashboard role can issue.
`sitegpt login --scope <scope>`	Request custom access. Repeat `--scope` for multiple scopes.
`sitegpt login --chatbot <chatbot-id>`	Restrict the token to selected chatbots. Repeatable.
`sitegpt login --token <token>`	Store an existing SiteGPT token locally instead of browser approval.

Options:

Option	Required	Description
`--profile <name>`	No	Save/use this local profile.
`--api-base <url>`	No	API base URL. Production is `https://sitegpt.ai`.
`--name <name>`	No	Token name shown in SiteGPT. Default: `SiteGPT CLI (<profile>)`.
`--full-access`	No	Request all allowed self-service scopes.
`--scope <scope>`	No	Request one custom scope. Repeatable.
`--chatbot <chatbot-id>`	No	Restrict token to a chatbot. Repeatable.
`--expires-in-days <1-365>`	No	Token lifetime. Default: `90`.
`--token <token>`	No	Store an existing token. Cannot be combined with device-login options.

Examples:

sitegpt login
sitegpt login --profile support-agent
sitegpt login --profile local --api-base http://127.0.0.1:8787
sitegpt login --full-access
sitegpt login --scope account:read --scope chatbots:read --scope knowledge:write
sitegpt login --chatbot <chatbot-id> --scope knowledge:read --scope knowledge:write
sitegpt login --token <sitegpt-token>

Manual dashboard-token flow:

Open the SiteGPT dashboard.
Go to Agents.
Click Create token.
Choose access level, scopes, and chatbot restrictions.
Copy the token while it is visible.
Save it locally:

sitegpt login --profile <profile-name> --token <sitegpt-token>
sitegpt --profile <profile-name> whoami

Logout

Logout removes the selected local profile from your machine. It does not revoke the token in SiteGPT.

Command	Description
`sitegpt logout`	Delete the default/selected local profile.
`sitegpt logout --profile <name>`	Delete a named local profile.

To revoke server-side access, use sitegpt tokens revoke <token-id>.

Whoami

Shows the authenticated account for the active token/profile.

Command	Description
`sitegpt whoami`	Show current user, profile, and auth method.
`sitegpt whoami --json`	Return account details as JSON.

Profiles

Profiles are local named credentials.

Command	Description
`sitegpt profiles list`	List saved local profiles.
`sitegpt profiles show`	Show the selected/default profile.
`sitegpt profiles show <profile>`	Show a named profile.
`sitegpt profiles use <profile>`	Make a profile the default.
`sitegpt profiles set-default <profile>`	Alias for `profiles use`.
`sitegpt profiles delete <profile>`	Delete a local profile.
`sitegpt profiles remove <profile>`	Alias for `profiles delete`.

Examples:

sitegpt profiles list
sitegpt profiles show default
sitegpt profiles use production
sitegpt -p support-agent whoami
sitegpt profiles delete local-test

Token scopes

Scopes control what a token can do.

Entity	Read	Write	Delete
Account	`account:read`	`account:write`	-
Billing	`billing:read`	`billing:write`	-
API tokens	`tokens:read`	`tokens:write`	-
Chatbots	`chatbots:read`	`chatbots:write`	`chatbots:delete`
Knowledge	`knowledge:read`	`knowledge:write`	`knowledge:delete`
Personas	`personas:read`	`personas:write`	`personas:delete`
Instructions	`instructions:read`	`instructions:write`	`instructions:delete`
Settings	`settings:read`	`settings:write`	-
Conversation starters	`starters:read`	`starters:write`	`starters:delete`
Conversation followups	`followups:read`	`followups:write`	`followups:delete`
Conversations	`conversations:read`	`conversations:write`	`conversations:delete`
Leads	`leads:read`	`leads:write`	`leads:delete`
Members	`members:read`	`members:write`	`members:delete`
Integrations	`integrations:read`	`integrations:write`	-

API tokens

API tokens are scoped credentials used by the CLI and agents.

Command	Description
`sitegpt tokens list`	List active API tokens.
`sitegpt tokens list --include-revoked`	Include revoked tokens in the list.
`sitegpt tokens create --name <name> --scope <scope>`	Create a new token.
`sitegpt tokens rotate <token-id>`	Rotate an existing token and revoke the old token.
`sitegpt tokens roll <token-id>`	Alias for `tokens rotate`.
`sitegpt tokens revoke <token-id>`	Revoke a token.
`sitegpt tokens delete <token-id>`	Alias for `tokens revoke`.

Create options:

Option	Required	Description
`--name <name>`	Yes	Token display name.
`--scope <scope>`	Yes	Scope to grant. Repeatable.
`--chatbot <chatbot-id>`	No	Restrict token to selected chatbots. Repeatable.
`--expires-in-days <1-365>`	No	Relative expiration. Default: `90`.
`--expires-at <iso-date>`	No	Absolute expiration. Cannot be combined with `--expires-in-days`.

Examples:

sitegpt tokens list
sitegpt tokens list --include-revoked --json
sitegpt tokens create --name "Knowledge agent" --scope account:read --scope chatbots:read --scope knowledge:write
sitegpt tokens create --name "One chatbot" --chatbot <chatbot-id> --scope knowledge:read --scope knowledge:write
sitegpt tokens rotate <token-id>
sitegpt tokens revoke <token-id>

New and rotated token secrets are shown once. Store them before closing the terminal or modal.

Account

Account commands manage your SiteGPT account profile.

Command	Description
`sitegpt account show`	Show account profile.
`sitegpt account update --name <name>`	Update account name.
`sitegpt account picture upload <path>`	Upload account profile picture.
`sitegpt account picture add <path>`	Alias for `picture upload`.
`sitegpt account picture delete --yes`	Delete account profile picture.
`sitegpt account picture remove --yes`	Alias for `picture delete`.

Examples:

sitegpt account show --json
sitegpt account update --name "Jane Doe"
sitegpt account picture upload ./avatar.png
sitegpt account picture delete --yes

Usage

Usage commands show account usage.

Command	Description
`sitegpt usage`	Show current account usage.
`sitegpt usage --json`	Return usage as JSON.

Limits

Limits commands show account quotas and remaining capacity.

Command	Description
`sitegpt limits`	Show account limits.
`sitegpt limits --json`	Return limits as JSON.

Billing

Billing commands are read-oriented account billing commands.

Command	Description
`sitegpt billing subscription`	Show subscription details.
`sitegpt billing invoices`	List invoices.

Examples:

sitegpt billing subscription --json
sitegpt billing invoices

Invoice output includes invoice number, status, billing date, amount, currency, and download URL when available.

Chatbots

Chatbots are the main SiteGPT resource. Most chatbot-scoped commands require --chatbot <chatbot-id>.

Command	Description
`sitegpt chatbots list`	List accessible chatbots.
`sitegpt chatbots get <chatbot-id>`	Show one chatbot.
`sitegpt chatbots create <title>`	Create a chatbot using a positional title.
`sitegpt chatbots create --title <title>`	Create a chatbot using the named title option.
`sitegpt chatbots update <chatbot-id>`	Update chatbot title and/or description.
`sitegpt chatbots delete <chatbot-id> --yes`	Delete a chatbot.

Create/update options:

Option	Applies to	Description
`--title <title>`	create, update	Chatbot title.
`--description <description>`	create, update	Chatbot description.

Examples:

sitegpt chatbots list --json
sitegpt chatbots get <chatbot-id>
sitegpt chatbots create "Acme Support" --description "Answers Acme customer questions" --json
sitegpt chatbots update <chatbot-id> --title "Acme Help"
sitegpt chatbots delete <chatbot-id> --yes

Dashboard summary

Dashboard commands return a chatbot operational summary.

Command	Description
`sitegpt dashboard --chatbot <chatbot-id>`	Show dashboard summary.
`sitegpt dashboard show --chatbot <chatbot-id>`	Alias form.
`sitegpt dashboard get --chatbot <chatbot-id>`	Alias form.

Example:

sitegpt dashboard --chatbot <chatbot-id> --json

The summary includes training state, document counts, knowledge counts, feedback summary, chat URL, and widget script URL.

Installation

Installation commands return widget install metadata.

Command	Description
`sitegpt installation snippet --chatbot <chatbot-id>`	Show chat URL, widget script URL, and embed code.

Example:

sitegpt installation snippet --chatbot <chatbot-id>

Icons

Icon commands upload or delete chatbot visual assets.

Command	Description
`sitegpt icons upload --chatbot <chatbot-id> <type> <image-path>`	Upload a chatbot icon.
`sitegpt icons add --chatbot <chatbot-id> <type> <image-path>`	Alias for `icons upload`.
`sitegpt icons delete --chatbot <chatbot-id> <type> --yes`	Delete a chatbot icon.
`sitegpt icons remove --chatbot <chatbot-id> <type> --yes`	Alias for `icons delete`.

Icon types:

bot, person, agent, watermark, chat-bubble

Supported image extensions:

png, jpg, jpeg, webp, gif, avif, svg

Examples:

sitegpt icons upload --chatbot <chatbot-id> bot ./bot.png
sitegpt icons upload --chatbot <chatbot-id> chat-bubble ./logo.png
sitegpt icons delete --chatbot <chatbot-id> watermark --yes

Knowledge documents

Documents are individual ingested knowledge items.

Command	Description
`sitegpt knowledge documents list --chatbot <chatbot-id>`	List knowledge documents.
`sitegpt knowledge docs list --chatbot <chatbot-id>`	Alias for `knowledge documents list`.
`sitegpt knowledge documents get --chatbot <chatbot-id> <document-id>`	Show one document.
`sitegpt knowledge documents get --chatbot <chatbot-id> <document-id> --content`	Include raw/parsed content when available.
`sitegpt knowledge documents get --chatbot <chatbot-id> <document-id> --include-content`	Alias-style content inclusion.
`sitegpt knowledge documents stats --chatbot <chatbot-id>`	Show document stats.
`sitegpt knowledge documents edit --chatbot <chatbot-id> <document-id>`	Update document content.
`sitegpt knowledge documents update --chatbot <chatbot-id> <document-id>`	Alias for `documents edit`.
`sitegpt knowledge documents update-config --chatbot <chatbot-id> --document <document-id>`	Update scrape/sync config for documents.
`sitegpt knowledge documents resync --chatbot <chatbot-id> <document-id>`	Resync one or more documents.
`sitegpt knowledge documents delete --chatbot <chatbot-id> <document-id> --yes`	Delete one or more documents.
`sitegpt knowledge documents remove --chatbot <chatbot-id> <document-id> --yes`	Alias for `documents delete`.

List filters:

Option	Description
`--query <text>`	Search documents.
`--source <source>`	Filter by source. Repeatable.
`--status <status>`	Filter by ingestion status. Repeatable.
`--type <type>`	Filter by document type. Repeatable.
`--limit <1-100>`	Limit results. Default: `50`.
`--cursor <cursor>`	Continue pagination.

Get options:

Option	Description
`--content`	Include raw/parsed content when available.
`--include-content`	Include raw/parsed content when available.
`--max-content-chars <number>`	Limit included content length.

Edit options:

Option	Description
`--content <text>`	New document content.
`--file <path>`	Read new document content from a file.

Stats options:

Option	Description
`--query <text>`	Search documents before calculating stats.
`--source <source>`	Filter stats by source. Repeatable.
`--status <status>`	Filter stats by ingestion status. Repeatable.
`--type <type>`	Filter stats by document type. Repeatable.

Update-config options:

Option	Description
`--document <id>`	Document ID to update. Repeatable.
`--document-id <id>`	Alias for `--document`. Repeatable.
`--sync <frequency>`	Set auto-sync frequency. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--only-main-content <boolean>`	Extract main page content only.
`--include-selector <selector>`	CSS selector to include. Repeatable.
`--exclude-selector <selector>`	CSS selector to exclude. Repeatable.
`--header "Name: value"`	Send request header. Repeatable. Allowed names: `User-Agent`, `Accept`, `Accept-Language`.

Bulk selector options for resync and delete:

Option	Description
Positional document IDs	Select exact document IDs.
`--document <id>`	Select a document ID. Repeatable.
`--document-id <id>`	Alias for `--document`. Repeatable.
`--state <state>`	Select by training state. Values: `all`, `trained`, `pending`, `failed`.
`--all`	Select all matching documents.
`--query`, `--source`, `--status`, `--type`	Narrow selected documents.

Source values:

TEXT, URLS_LIST, YOUTUBE, SITEMAP, WEBSITE, LOCAL_FILE,
NOTION, GOOGLE_DRIVE, DROPBOX, ONEDRIVE, BOX, SHAREPOINT,
CONFLUENCE, GITHUB

Status values:

BACKLOG, QUEUED, QUEUED_FOR_RESYNC, QUEUED_FOR_UPDATE,
QUEUED_FOR_DELETION, PROCESSING, SUCCESS, FAILED, CANCELLED

Type values:

TEXT, URL, FILE, NOTION_DOCUMENT, GOOGLE_DRIVE_DOCUMENT,
DROPBOX_DOCUMENT, ONEDRIVE_DOCUMENT, BOX_DOCUMENT,
SHAREPOINT_DOCUMENT, CONFLUENCE_DOCUMENT, GITHUB_DOCUMENT

Examples:

sitegpt knowledge documents list --chatbot <chatbot-id> --status FAILED --json
sitegpt knowledge documents get --chatbot <chatbot-id> <document-id> --content
sitegpt knowledge documents edit --chatbot <chatbot-id> <document-id> --file ./updated.md
sitegpt knowledge documents resync --chatbot <chatbot-id> --state failed
sitegpt knowledge documents delete --chatbot <chatbot-id> --document <document-id> --yes

Knowledge links

Links add exact URLs to a chatbot.

Command	Description
`sitegpt knowledge links add --chatbot <chatbot-id> <url...>`	Add one or more exact URLs.
`sitegpt knowledge links --chatbot <chatbot-id> <url...>`	Omitted `add` defaults to add.

Options:

Option	Description
`--sync <frequency>`	Auto-sync page content. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`. Default: `NEVER`.
`--only-main-content <boolean>`	Extract main page content only. Default: `true`.
`--include-selector <selector>`	CSS selector to include. Repeatable.
`--exclude-selector <selector>`	CSS selector to exclude. Repeatable.
`--header "Name: value"`	Send request header. Repeatable. Allowed names: `User-Agent`, `Accept`, `Accept-Language`.

Example:

sitegpt knowledge links add --chatbot <chatbot-id> https://example.com/pricing https://example.com/docs --only-main-content true

Knowledge website

Website commands crawl from a starting URL.

Command	Description
`sitegpt knowledge website add --chatbot <chatbot-id> <url>`	Crawl a website from a starting URL.
`sitegpt knowledge website --chatbot <chatbot-id> <url>`	Omitted `add` defaults to add.

Options:

Option	Description
`--depth <1-5>`	Maximum crawl depth. Default: `3`.
`--max-links <1-1000>`	Maximum URLs to queue. Default: `50`, capped by quota.
`--include-path <path>`	Include path pattern. Repeatable.
`--exclude-path <path>`	Exclude path pattern. Repeatable.
`--allowed-domain <domain>`	Allowed domain. Repeatable.
`--sync <frequency>`	Auto-sync page content. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--only-main-content <boolean>`	Extract main page content only. Default: `true`.
`--include-selector <selector>`	CSS selector to include. Repeatable.
`--exclude-selector <selector>`	CSS selector to exclude. Repeatable.
`--header "Name: value"`	Send request header. Repeatable.

Example:

sitegpt knowledge website add --chatbot <chatbot-id> https://docs.example.com --depth 3 --max-links 200 --include-path /docs

Knowledge sitemap

Sitemap commands add URLs from a sitemap.

Command	Description
`sitegpt knowledge sitemap add --chatbot <chatbot-id> <url>`	Add URLs from a sitemap.
`sitegpt knowledge sitemap --chatbot <chatbot-id> <url>`	Omitted `add` defaults to add.

Options:

Option	Description
`--max-links <1-1000>`	Maximum URLs to queue. Default: `50`, capped by quota.
`--include-path <path>`	Include path pattern. Repeatable.
`--exclude-path <path>`	Exclude path pattern. Repeatable.
`--sync <frequency>`	Auto-sync known page content. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--scan <frequency>`	Auto-scan sitemap for additions/deletions. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--only-main-content <boolean>`	Extract main page content only. Default: `true`.
`--include-selector <selector>`	CSS selector to include. Repeatable.
`--exclude-selector <selector>`	CSS selector to exclude. Repeatable.
`--header "Name: value"`	Send request header. Repeatable.

Example:

sitegpt knowledge sitemap add --chatbot <chatbot-id> https://example.com/sitemap.xml --sync WEEKLY --scan WEEKLY

Knowledge YouTube

YouTube commands add video URLs.

Command	Description
`sitegpt knowledge youtube add --chatbot <chatbot-id> <url...>`	Add one or more YouTube videos.
`sitegpt knowledge youtube --chatbot <chatbot-id> <url...>`	Omitted `add` defaults to add.

Options:

Option	Description
`--sync <frequency>`	Auto-sync video content. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.

Example:

sitegpt knowledge youtube add --chatbot <chatbot-id> https://www.youtube.com/watch?v=...

Knowledge text

Text commands create or replace the chatbot text knowledge document.

Command	Description
`sitegpt knowledge text update --chatbot <chatbot-id> <text>`	Replace text knowledge with inline text.
`sitegpt knowledge text update --chatbot <chatbot-id> --file <path>`	Replace text knowledge with file content.
`sitegpt knowledge text add --chatbot <chatbot-id> ...`	Alias for `text update`.
`sitegpt knowledge text --chatbot <chatbot-id> ...`	Omitted subcommand defaults to update.

Options:

Option	Description
`--name <name>`	Document name.
`--file <path>`	Read content from local file.

Examples:

sitegpt knowledge text update --chatbot <chatbot-id> "Support policy: ..."
sitegpt knowledge text update --chatbot <chatbot-id> --name FAQ --file ./faq.md

Knowledge files

File commands upload local files.

Command	Description
`sitegpt knowledge files add --chatbot <chatbot-id> <file...>`	Upload one or more local files.
`sitegpt knowledge files --chatbot <chatbot-id> <file...>`	Omitted `add` defaults to add.

Example:

sitegpt knowledge files add --chatbot <chatbot-id> ./guide.pdf ./faq.docx

Knowledge sync jobs

Sync jobs manage recurring sync and sitemap scan behavior. Jobs with NEVER are hidden from normal user-facing lists.

Command	Description
`sitegpt knowledge sync-jobs list --chatbot <chatbot-id>`	List recurring sync/scan jobs.
`sitegpt knowledge jobs list --chatbot <chatbot-id>`	Alias for `knowledge sync-jobs list`.
`sitegpt knowledge sync-jobs get --chatbot <chatbot-id> <job-id>`	Show one sync job.
`sitegpt knowledge sync-jobs update --chatbot <chatbot-id> <job-id>`	Update sync/scan frequency.
`sitegpt knowledge sync-jobs delete --chatbot <chatbot-id> <job-id> --yes`	Disable the job.
`sitegpt knowledge sync-jobs disable --chatbot <chatbot-id> <job-id> --yes`	Alias for delete.

List filters:

Option	Description
`--source <source>`	Filter by job source. Repeatable. Common values: `URLS_LIST`, `SITEMAP`, `WEBSITE`, `YOUTUBE`, `GITHUB`.
`--sync <frequency>`	Filter by sync frequency. Repeatable. Values: `DAILY`, `WEEKLY`, `MONTHLY`.
`--scan <frequency>`	Filter by scan frequency. Repeatable. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--limit <1-100>`	Default: `50`.
`--cursor <cursor>`	Continue pagination.

Update options:

Option	Description
`--sync <frequency>`	Set sync frequency. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--scan <frequency>`	Set scan frequency. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.

Examples:

sitegpt knowledge sync-jobs list --chatbot <chatbot-id>
sitegpt knowledge sync-jobs update --chatbot <chatbot-id> <job-id> --sync WEEKLY
sitegpt knowledge sync-jobs delete --chatbot <chatbot-id> <job-id> --yes

External data sources

Data-source commands connect cloud systems and ingest selected documents.

Command	Description
`sitegpt knowledge sources list --chatbot <chatbot-id>`	List source connections.
`sitegpt knowledge connections list --chatbot <chatbot-id>`	Alias for `knowledge sources list`.
`sitegpt knowledge sources create --chatbot <chatbot-id>`	Create a source connection.
`sitegpt knowledge sources add --chatbot <chatbot-id>`	Alias for create.
`sitegpt knowledge sources get --chatbot <chatbot-id> <source-id>`	Show one source.
`sitegpt knowledge sources update --chatbot <chatbot-id> <source-id>`	Update source metadata/credentials.
`sitegpt knowledge sources authorize --chatbot <chatbot-id> <source-id>`	Authorize or select more files.
`sitegpt knowledge sources reauthorize --chatbot <chatbot-id> <source-id>`	Alias for authorize.
`sitegpt knowledge sources select-files --chatbot <chatbot-id> <source-id>`	Alias for authorize.
`sitegpt knowledge sources picker --chatbot <chatbot-id> <source-id>`	Alias for authorize.
`sitegpt knowledge sources documents --chatbot <chatbot-id> <source-id>`	List selected source documents.
`sitegpt knowledge sources docs --chatbot <chatbot-id> <source-id>`	Alias for documents.
`sitegpt knowledge sources ingest --chatbot <chatbot-id> <source-id>`	Ingest selected source documents.
`sitegpt knowledge sources revoke --chatbot <chatbot-id> <source-id> --yes`	Revoke a source connection.
`sitegpt knowledge sources delete --chatbot <chatbot-id> <source-id> --yes`	Alias for revoke.

Connector values:

NOTION, GOOGLE_DRIVE, DROPBOX, ONEDRIVE, BOX, SHAREPOINT, CONFLUENCE, GITHUB

Status values:

PENDING, ACTIVE, FAILED, REVOKED

List filters:

Option	Description
`--connector <connector>`	Filter by connector.
`--status <status>`	Filter by connection status.

Create options:

Option	Applies to	Description
`--connector <connector>`	all	Connector type. Required.
`--name <name>`	all	Friendly connection name.
`--owner <owner>`	GitHub	GitHub owner.
`--api-key <token>`	GitHub	GitHub access token.
`--domain <domain>`	Confluence	Confluence domain.
`--label <label>`	all	Optional provider-visible label metadata.
`--client-redirect-url <url>`	OAuth/picker connectors	Redirect URL after provider authorization/picker.
`--metadata <json>`	all	Extra metadata object.

Update options:

Option	Description
`--name <name>`	Update source name.
`--api-key <token>`	Update API key for token-based sources.
`--client-redirect-url <url>`	Set redirect URL.
`--clear-client-redirect-url`	Clear redirect URL.

Authorize options:

Option	Description
`--client-redirect-url <url>`	Override the redirect URL for this authorization/picker flow.

Documents options:

Option	Description
`--limit <1-100>`	Default: `50`.
`--cursor <cursor>`	Continue pagination.

Ingest options:

Option	Description
`--sync <frequency>`	Auto-sync ingested source content. Values: `NEVER`, `DAILY`, `WEEKLY`, `MONTHLY`.
`--external-id <id>`	Ingest selected external document ID. Repeatable.
`--document <id>`	External document selector. Repeatable.
`--page <id>`	Page selector for page-based sources. Repeatable.
`--repo <repo>`	GitHub repository to ingest.
`--branch <branch>`	GitHub branch to ingest.
`--pattern <glob>`	GitHub file pattern. Repeatable.
`--metadata <json>`	Extra ingestion metadata.

Examples:

sitegpt knowledge sources create --chatbot <chatbot-id> --connector GOOGLE_DRIVE --name "Drive docs"
sitegpt knowledge sources authorize --chatbot <chatbot-id> <source-id>
sitegpt knowledge sources documents --chatbot <chatbot-id> <source-id>
sitegpt knowledge sources ingest --chatbot <chatbot-id> <source-id> --sync WEEKLY
sitegpt knowledge sources revoke --chatbot <chatbot-id> <source-id> --yes

GitHub source helpers

GitHub helpers are nested under knowledge sources github.

Command	Description
`sitegpt knowledge sources github repos --chatbot <chatbot-id> --source <source-id>`	List GitHub repositories.
`sitegpt knowledge sources github repositories --chatbot <chatbot-id> --source <source-id>`	Alias for `github repos`.
`sitegpt knowledge sources github files --chatbot <chatbot-id> --source <source-id> --owner <owner> --repo <repo>`	List files in a GitHub repository.

Repository options:

Option	Description
`--source <source-id>`	GitHub source ID. Required.
`--page <number>`	Page number.
`--per-page <1-100>`	Results per page.

File options:

Option	Description
`--source <source-id>`	GitHub source ID. Required.
`--owner <owner>`	Repository owner. Required.
`--repo <repo>`	Repository name. Required.
`--branch <branch>`	Branch name.

Examples:

sitegpt knowledge sources github repos --chatbot <chatbot-id> --source <source-id> --per-page 100
sitegpt knowledge sources github files --chatbot <chatbot-id> --source <source-id> --owner acme --repo docs --branch main
sitegpt knowledge sources ingest --chatbot <chatbot-id> <source-id> --repo docs --branch main --pattern "docs/**"

Confluence source helpers

Confluence helpers are nested under knowledge sources confluence.

Command	Description
`sitegpt knowledge sources confluence spaces --chatbot <chatbot-id> --source <source-id>`	List Confluence spaces.
`sitegpt knowledge sources confluence pages --chatbot <chatbot-id> --source <source-id> --space <space-id>`	List pages in a Confluence space.

Options:

Option	Applies to	Description
`--source <source-id>`	spaces, pages	Confluence source ID. Required.
`--space <space-id>`	pages	Confluence space ID. Required.
`--limit <1-100>`	spaces, pages	Limit results.
`--cursor <cursor>`	spaces, pages	Continue pagination.

Examples:

sitegpt knowledge sources confluence spaces --chatbot <chatbot-id> --source <source-id>
sitegpt knowledge sources confluence pages --chatbot <chatbot-id> --source <source-id> --space <space-id>
sitegpt knowledge sources ingest --chatbot <chatbot-id> <source-id> --page <page-id>

Custom responses

Custom Responses are manual question-and-answer overrides in the Knowledge area.

Command	Description
`sitegpt knowledge custom-responses list --chatbot <chatbot-id>`	List Custom Responses.
`sitegpt knowledge custom-responses get --chatbot <chatbot-id> <custom-response-id>`	Show one Custom Response.
`sitegpt knowledge custom-responses add --chatbot <chatbot-id>`	Add a Custom Response.
`sitegpt knowledge custom-responses create --chatbot <chatbot-id>`	Alias for add.
`sitegpt knowledge custom-responses update --chatbot <chatbot-id> <custom-response-id>`	Update a Custom Response.
`sitegpt knowledge custom-responses delete --chatbot <chatbot-id> <custom-response-id> --yes`	Delete a Custom Response.

Filters:

Option	Description
`--query <text>`	Search by question/text.
`--state <state>`	Values: `ALL`, `OPEN`, `UPDATED`. Default: `ALL`.
`--source <source>`	Values: `DOWNVOTED_BY_USER`, `MANUALLY_ADDED`, `MARKED_BY_ADMIN`. Repeatable.

Fields:

Option	Applies to	Description
`--question <question>`	add, update	Question text.
`--answer <answer>`	add, update	Approved answer text.
`--original-answer <answer>`	add	Optional original answer.

Examples:

sitegpt knowledge custom-responses list --chatbot <chatbot-id> --state OPEN
sitegpt knowledge custom-responses add --chatbot <chatbot-id> --question "Do you offer refunds?" --answer "Contact support for refund eligibility."
sitegpt knowledge custom-responses update --chatbot <chatbot-id> <custom-response-id> --answer "Updated approved answer."

Personas

Personas describe chatbot role, tone, and identity.

Command	Description
`sitegpt personas list --chatbot <chatbot-id>`	List personas.
`sitegpt personas get --chatbot <chatbot-id> <persona-id>`	Show one persona.
`sitegpt personas add --chatbot <chatbot-id>`	Create a persona.
`sitegpt personas create --chatbot <chatbot-id>`	Alias for add.
`sitegpt personas update --chatbot <chatbot-id> <persona-id>`	Update a persona.
`sitegpt personas use --chatbot <chatbot-id> <persona-id>`	Make a persona active.
`sitegpt personas delete --chatbot <chatbot-id> <persona-id> --yes`	Delete a persona.

Options:

Option	Applies to	Description
`--title <title>`	add, update	Persona title. Required for add.
`--description <description>`	add, update	Optional description.
`--instructions <text>`	add, update	Persona instructions.
`--file <path>`	add, update	Read persona instructions from file.

Examples:

sitegpt personas add --chatbot <chatbot-id> --title "Support specialist" --file ./persona.md --json
sitegpt personas use --chatbot <chatbot-id> <persona-id>
sitegpt personas update --chatbot <chatbot-id> <persona-id> --title "Friendly support specialist"

Instructions

Instructions control response behavior and temperature.

Command	Description
`sitegpt instructions list --chatbot <chatbot-id>`	List instructions.
`sitegpt instructions get --chatbot <chatbot-id> <instruction-id>`	Show one instruction.
`sitegpt instructions add --chatbot <chatbot-id>`	Create an instruction set.
`sitegpt instructions create --chatbot <chatbot-id>`	Alias for add.
`sitegpt instructions update --chatbot <chatbot-id> <instruction-id>`	Update an instruction set.
`sitegpt instructions use --chatbot <chatbot-id> <instruction-id>`	Make an instruction set active.
`sitegpt instructions delete --chatbot <chatbot-id> <instruction-id> --yes`	Delete an instruction set.

Options:

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

Examples:

sitegpt instructions add --chatbot <chatbot-id> --file ./instructions.md --temperature 0.3 --json
sitegpt instructions use --chatbot <chatbot-id> <instruction-id>

Settings overview

Settings can be read all at once, updated from a JSON file, or changed section by section.

Command	Description
`sitegpt settings get --chatbot <chatbot-id>`	Show all settings.
`sitegpt settings get --chatbot <chatbot-id> <section>`	Show one settings section.
`sitegpt settings update --chatbot <chatbot-id> --file <settings.json>`	Update settings from JSON.
`sitegpt settings <section> get --chatbot <chatbot-id>`	Show a section.
`sitegpt settings <section> update --chatbot <chatbot-id>`	Update a section.
`sitegpt settings <section> set --chatbot <chatbot-id>`	Alias for section update.

Sections:

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

Accepted aliases:

chatMode, leadForm, humanSupport, userData

Settings: general

Command	Description
`sitegpt settings general get --chatbot <chatbot-id>`	Show general settings.
`sitegpt settings general update --chatbot <chatbot-id>`	Update general settings.
`sitegpt settings general set --chatbot <chatbot-id>`	Alias for update.

Options:

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>`	Values: `gpt-3.5-turbo`, `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.

Settings: appearance

Command	Description
`sitegpt settings appearance get --chatbot <chatbot-id>`	Show appearance settings.
`sitegpt settings appearance update --chatbot <chatbot-id>`	Update appearance settings.
`sitegpt settings appearance set --chatbot <chatbot-id>`	Alias for update.

Text and color options:

Option	Description
`--file <section.json>`	Merge JSON file with flag updates.
`--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.
`--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.

Layout and enum options:

Option	Values/default
`--icon-size <size>`	`SMALL`, `MEDIUM`, `LARGE`, `XL`, `2XL`, `3XL`, `4XL`, `5XL`. Default: `SMALL`.
`--icon-position <position>`	`LEFT`, `RIGHT`. Default: `RIGHT`.
`--icon-shape <shape>`	`CIRCLE`, `SQUARE`. Default: `CIRCLE`.
`--desktop-auto-open <mode>`	`ALWAYS_OPEN_WITH_DELAY`, `DONT_OPEN`. Default: `DONT_OPEN`.
`--mobile-auto-open <mode>`	`ALWAYS_OPEN_WITH_DELAY`, `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`.

Boolean options:

--icon-background-transparent
--hide-sources
--hide-tooltip
--hide-watermark
--hide-feedback-buttons
--hide-bottom-navigation
--show-messages-tab-anonymous
--hide-refresh-button
--hide-expand-button
--hide-home-page
--rtl
--stay-on-home-if-no-thread
--require-terms
--hide-terms-after-acceptance
--dark-mode

Example:

sitegpt settings appearance update --chatbot <chatbot-id> --brand-color "#155DEE" --brand-text-color "#FFFFFF" --icon-shape CIRCLE

Settings: chat mode

Command	Description
`sitegpt settings chat-mode get --chatbot <chatbot-id>`	Show chat mode settings.
`sitegpt settings chat-mode set --chatbot <chatbot-id> AI`	Set AI mode.
`sitegpt settings chat-mode set --chatbot <chatbot-id> AGENT`	Set human/agent mode.

Mode values:

AI, AGENT

Settings: localization

Command	Description
`sitegpt settings localization get --chatbot <chatbot-id>`	Show localization settings.
`sitegpt settings localization update --chatbot <chatbot-id> --file <section.json>`	Update localization from JSON.
`sitegpt settings localization set --chatbot <chatbot-id> --file <section.json>`	Alias for update.

Settings: advanced

Command	Description
`sitegpt settings advanced get --chatbot <chatbot-id>`	Show advanced settings.
`sitegpt settings advanced update --chatbot <chatbot-id>`	Update advanced settings.
`sitegpt settings advanced set --chatbot <chatbot-id>`	Alias for update.

Options:

Option	Values/default
`--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.

Settings: user data

Command	Description
`sitegpt settings user-data get --chatbot <chatbot-id>`	Show user data settings.
`sitegpt settings user-data update --chatbot <chatbot-id>`	Update user data settings.
`sitegpt settings user-data set --chatbot <chatbot-id>`	Alias for update.

Options:

Option	Values/default
`--file <section.json>`	Merge JSON file with flag updates.
`--collect <mode>`	`MANDATORY`, `OPTIONAL`, `DO_NOT_COLLECT`. Default: `OPTIONAL`.
`--collect-name <boolean>`	Default: `false`.
`--collect-phone <boolean>`	Default: `false`.

Settings: lead form

Command	Description
`sitegpt settings lead-form get --chatbot <chatbot-id>`	Show lead form settings.
`sitegpt settings lead-form update --chatbot <chatbot-id>`	Update lead form settings.
`sitegpt settings lead-form set --chatbot <chatbot-id>`	Alias for update.

Options:

Option	Values/default
`--file <section.json>`	Merge JSON file with flag updates.
`--enabled <boolean>`	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>`	Notification email. Repeatable.

Settings: human support

Command	Description
`sitegpt settings human-support get --chatbot <chatbot-id>`	Show human support settings.
`sitegpt settings human-support update --chatbot <chatbot-id>`	Update human support settings.
`sitegpt settings human-support set --chatbot <chatbot-id>`	Alias for update.

Options:

Option	Description
`--file <section.json>`	Merge JSON file with flag updates.
`--enabled <boolean>`	Enable human support.
`--positive-prompt <text>`	Positive prompt.
`--request-prompt <text>`	Human support request prompt.
`--confirmation <text>`	Confirmation text.
`--show-buttons <boolean>`	Show support buttons.
`--replace-suggestions <boolean>`	Replace suggestions with support prompts.
`--notifications-enabled <boolean>`	Enable support notifications.
`--notification-email <email>`	Support notification email. Repeatable.
`--new-conversation-notifications-enabled <boolean>`	Enable new conversation notifications.
`--new-conversation-email <email>`	New conversation notification email. Repeatable.

Settings: webhooks

Command	Description
`sitegpt settings webhooks get --chatbot <chatbot-id>`	Show webhook settings.
`sitegpt settings webhooks update --chatbot <chatbot-id>`	Update webhook settings.
`sitegpt settings webhooks set --chatbot <chatbot-id>`	Alias for update.

Options:

Option	Description
`--file <section.json>`	Merge JSON file with flag updates.
`--message-url <url>`	Message webhook URL.
`--message-token <token>`	Message webhook token.
`--escalation-url <url>`	Escalation webhook URL.
`--escalation-token <token>`	Escalation webhook token.
`--leads-url <url>`	Leads webhook URL.
`--leads-token <token>`	Leads webhook token.

Conversation starters

Conversation starters are prompt buttons shown before a visitor sends a message.

Command	Description
`sitegpt starters list --chatbot <chatbot-id>`	List starters.
`sitegpt starters get --chatbot <chatbot-id> <starter-id>`	Show one starter.
`sitegpt starters add --chatbot <chatbot-id>`	Add a starter.
`sitegpt starters create --chatbot <chatbot-id>`	Alias for add.
`sitegpt starters update --chatbot <chatbot-id> <starter-id>`	Update a starter.
`sitegpt starters delete --chatbot <chatbot-id> <starter-id> --yes`	Delete a starter.
`sitegpt starters reorder --chatbot <chatbot-id> <id...>`	Reorder starters.

Options:

Option	Applies to	Description
`--title <title>`	add, update	Button title.
`--message <message>`	add, update	Prompt message.
`--description <message>`	add, update	Alias-style message input.
`--link <url>`	add, update	Link target. Implies `LINK` type.
`--type <type>`	add, update	`PROMPT` or `LINK`. Default: `PROMPT`.

Conversation followups

Conversation followups are prompt buttons shown after chatbot responses.

Command	Description
`sitegpt followups list --chatbot <chatbot-id>`	List followups.
`sitegpt followups get --chatbot <chatbot-id> <followup-id>`	Show one followup.
`sitegpt followups add --chatbot <chatbot-id>`	Add a followup.
`sitegpt followups create --chatbot <chatbot-id>`	Alias for add.
`sitegpt followups update --chatbot <chatbot-id> <followup-id>`	Update a followup.
`sitegpt followups delete --chatbot <chatbot-id> <followup-id> --yes`	Delete a followup.
`sitegpt followups reorder --chatbot <chatbot-id> <id...>`	Reorder followups.

Options:

Option	Applies to	Description
`--title <title>`	add, update	Button title.
`--message <message>`	add, update	Prompt message.
`--description <message>`	add, update	Alias-style message input.
`--link <url>`	add, update	Link target. Implies `LINK` type.
`--type <type>`	add, update	`PROMPT`, `LINK`, `ESCALATION`. Default: `PROMPT`.
`--escalation`	add, update	Create/update as escalation prompt.

Conversations

Conversations are visitor chat threads.

Command	Description
`sitegpt conversations list --chatbot <chatbot-id>`	List conversations.
`sitegpt conversations get --chatbot <chatbot-id> <thread-id>`	Show one conversation.
`sitegpt conversations update --chatbot <chatbot-id> <thread-id>`	Update conversation metadata.
`sitegpt conversations star --chatbot <chatbot-id> <thread-id>`	Star a conversation.
`sitegpt conversations unstar --chatbot <chatbot-id> <thread-id>`	Unstar a conversation.
`sitegpt conversations resolve --chatbot <chatbot-id> <thread-id>`	Resolve a conversation.
`sitegpt conversations unresolve --chatbot <chatbot-id> <thread-id>`	Reopen a conversation.
`sitegpt conversations read --chatbot <chatbot-id> <thread-id>`	Mark read.
`sitegpt conversations unread --chatbot <chatbot-id> <thread-id>`	Mark unread.
`sitegpt conversations escalate --chatbot <chatbot-id> <thread-id>`	Escalate to human support.
`sitegpt conversations switch-to-ai --chatbot <chatbot-id> <thread-id>`	Return to AI mode.
`sitegpt conversations delete --chatbot <chatbot-id> <thread-id> --yes`	Delete a conversation.
`sitegpt conversations bulk --chatbot <chatbot-id> --action <action> <thread-id...>`	Run a bulk action.

List filters:

Option	Values/default
`--status <status>`	`all`, `open`, `resolved`. Default: `all`.
`--mode <mode>`	`AI`, `AGENT`.
`--escalated <boolean>`	Filter by escalation state.
`--important <boolean>`	Filter by important/starred state.
`--read <boolean>`	Filter by read state.
`--lead <lead-id>`	Filter by linked lead.
`--query <text>`	Search conversations.
`--tag <tag-id>`	Filter by tag. Repeatable.
`--include-empty`	Include empty threads.
`--limit <1-100>`	Default: `50`.
`--cursor <cursor>`	Continue pagination.

Update options:

Option	Description
`--title <title>`	Set conversation title.
`--mode <mode>`	`AI` or `AGENT`.
`--important <boolean>`	Star/unstar.
`--resolved <boolean>`	Resolve/reopen.
`--escalated <boolean>`	Set escalation state.
`--mark-read <boolean>`	Mark read/unread.
`--tag <tag-id>`	Replace assigned tags with provided IDs. Repeatable.
`--email <email>`	Update visitor email.
`--name <name>`	Update visitor name.
`--phone <phone>`	Update visitor phone.
`--webhook-url <url>`	Update webhook URL.
`--webhook-token <token>`	Update webhook token.

Escalation and mode-switch options:

Option	Applies to	Description
`--message <message>`	`escalate`, `switch-to-ai`	Optional message to send while changing mode.

Bulk actions:

star, unstar, resolve, unresolve, mark-read, mark-unread, delete

Examples:

sitegpt conversations list --chatbot <chatbot-id> --escalated true --json
sitegpt conversations get --chatbot <chatbot-id> <thread-id>
sitegpt conversations update --chatbot <chatbot-id> <thread-id> --tag <tag-id> --important true
sitegpt conversations bulk --chatbot <chatbot-id> --action resolve <thread-id> <thread-id>

Messages

Messages are individual entries inside a conversation.

Command	Description
`sitegpt messages list --chatbot <chatbot-id> <thread-id>`	List messages in a conversation.
`sitegpt messages send --chatbot <chatbot-id> <thread-id> <message>`	Send a visitor message into an existing conversation.
`sitegpt messages send --chatbot <chatbot-id> <message>`	Start a new conversation with a visitor message.
`sitegpt messages react --chatbot <chatbot-id> <thread-id> <message-id> <reaction>`	Set message reaction.
`sitegpt messages edit --chatbot <chatbot-id> <thread-id> <message-id> <text>`	Edit message text.

List options:

Option	Values/default
`--limit <1-500>`	Default: `100`.
`--cursor <cursor>`	Continue pagination.

Reaction values:

POSITIVE, NEGATIVE, NEUTRAL

Examples:

sitegpt messages list --chatbot <chatbot-id> <thread-id> --json
sitegpt messages send --chatbot <chatbot-id> "What can you help with?"
sitegpt messages send --chatbot <chatbot-id> <thread-id> "Can I talk to support?"
sitegpt messages react --chatbot <chatbot-id> <thread-id> <message-id> NEGATIVE

Leads

Leads are collected visitor/contact records.

Command	Description
`sitegpt leads list --chatbot <chatbot-id>`	List leads.
`sitegpt leads get --chatbot <chatbot-id> <lead-id>`	Show one lead.
`sitegpt leads update --chatbot <chatbot-id> <lead-id>`	Update lead fields.
`sitegpt leads star --chatbot <chatbot-id> <lead-id>`	Star a lead.
`sitegpt leads unstar --chatbot <chatbot-id> <lead-id>`	Unstar a lead.
`sitegpt leads archive --chatbot <chatbot-id> <lead-id>`	Archive a lead.
`sitegpt leads unarchive --chatbot <chatbot-id> <lead-id>`	Unarchive a lead.
`sitegpt leads delete --chatbot <chatbot-id> <lead-id> --yes`	Delete a lead.
`sitegpt leads bulk --chatbot <chatbot-id> --action <action> <lead-id...>`	Run a bulk action.

List filters:

Option	Values/default
`--status <status>`	`all`, `open`, `archived`. Default: `all`.
`--important <boolean>`	Filter by starred state.
`--query <text>`	Search leads.
`--limit <1-100>`	Default: `50`.
`--cursor <cursor>`	Continue pagination.

Update options:

Option	Description
`--name <name>`	Lead name.
`--phone <phone>`	Lead phone.
`--important <boolean>`	Star/unstar.
`--archived <boolean>`	Archive/unarchive.

Bulk options:

Option	Description
`--action <action>`	`archive`, `unarchive`, `star`, `unstar`, `delete`.
`--lead <lead-id>`	Lead ID selector. Repeatable.
Positional lead IDs	Lead ID selectors.
`--yes`	Required for bulk delete.

Examples:

sitegpt leads list --chatbot <chatbot-id> --status open --json
sitegpt leads update --chatbot <chatbot-id> <lead-id> --name "Jane Doe" --important true
sitegpt leads bulk --chatbot <chatbot-id> --action archive <lead-id> <lead-id>

Members

Members are users with access to a chatbot.

Command	Description
`sitegpt members list --chatbot <chatbot-id>`	List chatbot members.
`sitegpt members invite --chatbot <chatbot-id> <email>`	Invite a member.
`sitegpt members invite --chatbot <chatbot-id> <email> --role <role>`	Invite with a specific role.
`sitegpt members remove --chatbot <chatbot-id> <user-id> --yes`	Remove a member.
`sitegpt members delete --chatbot <chatbot-id> <user-id> --yes`	Alias for remove.

Role values:

AGENT, MANAGER, ADMIN, SUPER_ADMIN

Examples:

sitegpt members list --chatbot <chatbot-id>
sitegpt members invite --chatbot <chatbot-id> teammate@example.com --role MANAGER
sitegpt members remove --chatbot <chatbot-id> <user-id> --yes

Member invites

Member invite commands manage pending chatbot invitations.

Command	Description
`sitegpt member-invites list --chatbot <chatbot-id>`	List pending invites.
`sitegpt member-invites cancel --chatbot <chatbot-id> <invite-id> --yes`	Cancel an invite.
`sitegpt member-invites delete --chatbot <chatbot-id> <invite-id> --yes`	Alias for cancel.

Example:

sitegpt member-invites list --chatbot <chatbot-id> --json
sitegpt member-invites cancel --chatbot <chatbot-id> <invite-id> --yes

Command	Description
`sitegpt tags list`	List tags.
`sitegpt tags list --query <text>`	Search tags.
`sitegpt tags get <tag-id>`	Show one tag.
`sitegpt tags add <title>`	Create a tag with a positional title.
`sitegpt tags add --title <title>`	Create a tag with named title option.
`sitegpt tags create <title>`	Alias for add.
`sitegpt tags update <tag-id> --title <title>`	Rename a tag.
`sitegpt tags delete <tag-id> --yes`	Delete a tag.

Option	Description
`--id <id>`	Optional custom tag ID on create.
`--title <title>`	Tag title.
`--query <text>`	Search query for list.

Get started

Chatbot setup

Operations

Agent playbooks

Reference

Documentation Index

​How to read this reference

​Global options

​Login

​Logout

​Whoami

​Profiles

​Token scopes

​API tokens

​Account

​Usage

​Limits

​Billing

​Chatbots

​Dashboard summary

​Installation

​Icons

​Knowledge documents

​Knowledge links

​Knowledge website

​Knowledge sitemap

​Knowledge YouTube

​Knowledge text

​Knowledge files

​Knowledge sync jobs

​External data sources

​GitHub source helpers

​Confluence source helpers

​Custom responses

​Personas

​Instructions

​Settings overview

​Settings: general

​Settings: appearance

​Settings: chat mode

​Settings: localization

​Settings: advanced

​Settings: user data

​Settings: lead form

​Settings: human support

​Settings: webhooks

​Conversation starters

​Conversation followups

​Conversations

​Messages

​Tags

​Leads

​Members

​Member invites

How to read this reference

Global options

Login

Logout

Whoami

Profiles

Token scopes

API tokens

Account

Usage

Limits

Billing

Chatbots

Dashboard summary

Installation

Icons

Knowledge documents

Knowledge links

Knowledge website

Knowledge sitemap

Knowledge YouTube

Knowledge text

Knowledge files

Knowledge sync jobs

External data sources

GitHub source helpers

Confluence source helpers

Custom responses

Personas

Instructions

Settings overview

Settings: general

Settings: appearance

Settings: chat mode

Settings: localization

Settings: advanced

Settings: user data

Settings: lead form

Settings: human support

Settings: webhooks

Conversation starters

Conversation followups

Conversations

Messages

Tags

Leads

Members

Member invites