Node CLI command reference

@toothfairyai/cli@latest…

Every command below is a subcommand of toothfairy (alias tf). Global credentials come from TF_API_KEY / TF_WORKSPACE_ID or toothfairy configure.

120 commands.

Index

Command	Summary
`billing`	Get monthly billing costs
`billing-month-costs`	Get monthly usage and cost information
`cancel-benchmark-run`	Cancel a running benchmark
`chat`	Start an interactive chat session with a ToothFairyAI agent (use @ to reference local files)
`chats`	List all chats in the workspace
`config-show`	Show current configuration
`configure`	Configure ToothFairy CLI credentials and settings
`create-agent`	Create a new agent
`create-authorisation`	Create a new authorisation
`create-authorization`	Create a new authorization
`create-benchmark`	Create a new benchmark
`create-channel`	Create a new channel
`create-connection`	Create a new connection (Hosting for LLM/API endpoints)
`create-doc`	Create a document from a file path or URL with automatic type detection
`create-entity`	Create a new entity with specified type
`create-folder`	Create a new folder with specified name
`create-function`	Create a new agent function
`create-hook`	Create a new hook
`create-member`	Create a new workspace member
`create-prompt`	Create a new prompt with specified parameters
`create-scheduled-job`	Create a new scheduled job
`create-secret`	Create a new secret
`create-trigger`	Create a new event-driven agent trigger
`delete-agent`	Delete an agent
`delete-authorisation`	Delete an authorisation
`delete-authorization`	Delete an authorization
`delete-benchmark`	Delete a benchmark
`delete-channel`	Delete a channel
`delete-connection`	Delete a connection
`delete-doc`	Delete a document
`delete-entity`	Delete an entity
`delete-folder`	Delete a folder
`delete-function`	Delete a function
`delete-hook`	Delete a hook
`delete-member`	Delete a member
`delete-prompt`	Delete a prompt
`delete-scheduled-job`	Delete a scheduled job
`delete-secret`	Delete a secret
`delete-site`	Delete a site
`delete-trigger`	Delete a trigger
`download`	Download a file from ToothFairy workspace
`generate-speech`	Generate speech audio from text using ToothFairyAI
`get-agent`	Get details of a specific agent
`get-authorisation`	Get details of a specific authorisation
`get-authorization`	Get details of a specific authorization
`get-benchmark`	Get details of a specific benchmark
`get-benchmark-run`	Get a benchmark run by ID with score and metadata
`get-channel`	Get details of a specific channel
`get-charting-settings`	Get charting settings
`get-connection`	Get details of a specific connection
`get-dictionary`	Get dictionary entry
`get-doc`	Get details of a specific document
`get-embedding`	Get embedding for text
`get-embeddings-settings`	Get embeddings settings
`get-entity`	Get details of a specific entity
`get-folder`	Get details of a specific folder
`get-function`	Get details of a specific function
`get-hook`	Get details of a specific hook
`get-member`	Get details of a specific member
`get-prompt`	Get details of a specific prompt
`get-request`	Get details of a specific request
`get-scheduled-job`	Get details of a specific scheduled job
`get-site`	Get details of a specific site
`get-stream`	Get details of a specific stream
`get-trigger`	Get a specific trigger by ID
`help-guide`	Show detailed help and usage examples
`list-agents`	List all agents
`list-authorisations`	List all authorisations
`list-authorizations`	List all authorizations
`list-benchmark-runs`	List benchmark runs for the workspace
`list-benchmarks`	List all benchmarks
`list-channels`	List all channels
`list-connections`	List all connections
`list-dictionaries`	List all dictionaries
`list-entities`	List all entities in the workspace
`list-folders`	List all folders in the workspace
`list-functions`	List all functions
`list-hooks`	List all hooks
`list-members`	List all members
`list-messages-bychat`	List all messages in a specific chat
`list-prompts`	List all prompts in the workspace
`list-requests`	List all requests
`list-scheduled-jobs`	List all scheduled jobs
`list-scheduled-jobs-by-status`	List scheduled jobs filtered by status
`list-sites`	List all sites
`list-streams`	List all streams
`list-triggers`	List all triggers in the workspace
`migrate`	Migrate an agent from one profile to another
`pause-scheduled-job`	Pause a scheduled job
`pause-trigger`	Pause (disarm) a trigger
`predict`	Generate streaming AI predictions (OpenAI-compatible) from a ToothFairyAI model
`process-audio`	Process audio file and generate text using ToothFairyAI
`profile`	Show profiles, switch to, or delete a profile
`resume-scheduled-job`	Resume a paused scheduled job
`resume-trigger`	Resume (arm) a paused trigger
`run-benchmark`	Start a benchmark run to evaluate an agent
`search`	Search for documents in the knowledge hub
`send`	Send a message to a ToothFairyAI agent
`send-stream`	Send a message to a ToothFairyAI agent with real-time streaming response
`setup`	Create or update a tfcode profile in ~/.tfcode/profiles.json
`update-agent`	Update an existing agent
`update-authorisation`	Update an existing authorisation
`update-authorization`	Update an existing authorization
`update-benchmark`	Update an existing benchmark
`update-channel`	Update an existing channel
`update-charting-settings`	Update charting settings
`update-connection`	Update an existing connection
`update-doc`	Update an existing document
`update-embeddings-settings`	Update embeddings settings
`update-entity`	Update an existing entity
`update-folder`	Update an existing folder
`update-function`	Update an existing function
`update-hook`	Update an existing hook
`update-member`	Update a member
`update-prompt`	Update an existing prompt
`update-scheduled-job`	Update an existing scheduled job
`update-site`	Update a site
`update-trigger`	Update an existing trigger
`upload`	Upload a file to ToothFairy workspace
`validate`	Validate ToothFairyAI credentials

billing

Get monthly billing costs

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy billing

billing-month-costs

Get monthly usage and cost information

Arguments

Name	Description
`<month>`	Month number (1-12)
`<year>`	Year (4-digit)

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy billing-month-costs <month> <year>

cancel-benchmark-run

Cancel a running benchmark

Arguments

Name	Description
`<run_id>`	Run ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy cancel-benchmark-run <run_id>

chat

Start an interactive chat session with a ToothFairyAI agent (use @ to reference local files)

Options

Flag	Description
`--agent-id <id>`	Agent ID to chat with (uses default if configured)
`--chat-id <id>`	Resume an existing chat conversation
`-v, --verbose`	Show detailed information
`--show-progress`	Show agent processing status updates

toothfairy chat

chats

List all chats in the workspace

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy chats

config-show

Show current configuration

toothfairy config-show

configure

Configure ToothFairy CLI credentials and settings

Options

Flag	Description
`--base-url <url>`	ToothFairy API base URL
`--ai-url <url>`	ToothFairyAI URL
`--ai-stream-url <url>`	ToothFairyAI Streaming URL
`--api-key <key>`	API key
`--workspace-id <id>`	Workspace ID
`--user-id <id>`	User ID
`--default-agent-id <id>`	Default agent ID for send/chat commands
`--config-path <path>`	Path to save config file

toothfairy configure

create-agent

Create a new agent

Options

Flag	Description
`--label <label>`	Agent label
`--description <description>`	Agent description
`--emoji <emoji>`	Agent emoji
`--mode <mode>`	Agent mode (speed
`--agent-type <type>`	Agent type (Chatbot
`--llm-provider <provider>`	LLM provider name
`--llm-base-model <model>`	LLM base model name
`--llm-url <url>`	LLM URL endpoint
`--reasoning-mode <mode>`	Reasoning mode (auto
`--reasoning-effort <effort>`	Reasoning effort (none
`--fn-reasoning-effort <effort>`	Function reasoning effort (none
`--voice-name <name>`	Voice name for voice agents
`--agents-pool <ids>`	Comma-separated agent IDs for agents pool
`--mcps <ids>`	Comma-separated MCP IDs
`--rag-search-strategy <strategy>`	RAG search strategy (parallel
`--re-rag`	Enable re-ranking for RAG
`--internet-search-modes <modes>`	Comma-separated internet search modes (search
`--sip-phone-number <number>`	SIP phone number
`--sip-dispatch-rule-id <id>`	SIP dispatch rule ID
`--enable-inbound-sip`	Enable inbound SIP
`--enable-outbound-sip`	Enable outbound SIP
`--temperature <temp>`	Temperature (0.0-2.0)
`--max-tokens <tokens>`	Max tokens
`--max-history <history>`	Max conversation history
`--top-k <k>`	Top K for retrieval
`--doc-top-k <k>`	Document top K
`--interpolation-string <string>`	System prompt template
`--goals <goals>`	Agent goals
`--department <dept>`	Department (HUMAN_RESOURCES
`--allow-images-upload`	Allow image uploads
`--allow-videos-upload`	Allow video uploads
`--allow-audios-upload`	Allow audio uploads
`--allow-docs-upload`	Allow document uploads
`--allow-internet-search`	Allow internet search
`--agentic-rag`	Enable agentic RAG
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-agent

create-authorisation

Create a new authorisation

Options

Flag	Description
`--name <name>`	Authorisation name
`--permissions <permissions>`	Permissions (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-authorisation

create-authorization

Create a new authorization

Options

Flag	Description
`--name <name>`	Authorization name
`--type <type>`	Authorization type
`--config <config>`	Authorization configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-authorization

create-benchmark

Create a new benchmark

Options

Flag	Description
`--name <name>`	Benchmark name
`--description <description>`	Benchmark description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-benchmark

create-channel

Create a new channel

Options

Flag	Description
`--name <name>`	Channel name
`--type <type>`	Channel type
`--config <config>`	Channel configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-channel

create-connection

Create a new connection (Hosting for LLM/API endpoints)

Options

Flag	Description
`--name <name>`	Connection name
`--type <type>`	Hosting type (azure_openai
`--endpoint <url>`	API endpoint URL
`--model-name <name>`	Model name
`--base-model <model>`	Base model
`--custom-model`	Mark as custom model
`--api-version <version>`	API version
`--token-secret <secret>`	Token secret reference
`--description <desc>`	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-connection

create-doc

Create a document from a file path or URL with automatic type detection

Arguments

Name	Description
`<file-path-or-url>`	Path to file or URL to create document from

Options

Flag	Description
`--user-id <id>`	User ID (optional, uses configured value if not provided)
`--title <title>`	Document title (defaults to filename or URL)
`--folder-id <id>`	Folder ID (defaults to
`--topics <topics>`	Comma-separated topic IDs
`--status <status>`	Document status (draft
`--scope <scope>`	Document scope
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed creation information

toothfairy create-doc <file-path-or-url>

create-entity

Create a new entity with specified type

Arguments

Name	Description
`<label>`	Entity label

Options

Flag	Description
`--user-id <id>`	User ID (optional, uses configured value if not provided)
`--type <type>`	Entity type (intent
`--description <desc>`	Entity description
`--emoji <emoji>`	Entity emoji
`--parent-entity <id>`	Parent entity ID
`--background-color <color>`	Background color (hex format)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed creation information

toothfairy create-entity <label>

create-folder

Create a new folder with specified name

Arguments

Name	Description
`<name>`	Folder name

Options

Flag	Description
`--user-id <id>`	User ID (optional, uses configured value if not provided)
`--description <desc>`	Folder description
`--emoji <emoji>`	Folder emoji
`--status <status>`	Folder status
`--parent <id>`	Parent folder ID
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed creation information

toothfairy create-folder <name>

create-function

Create a new agent function

Options

Flag	Description
`--name <name>`	Function name
`--description <description>`	Function description
`--code <code>`	Function code
`--url <url>`	Function URL endpoint
`--request-type <type>`	Request type (get
`--authorisation-type <type>`	Authorisation type (bearer
`--scope <scope>`	Function scope (customerAuthentication
`--is-mcp-server`	Mark as MCP server
`--is-agent-skill`	Mark as agent skill
`--is-callback-fn`	Mark as callback function
`--is-hand-off-fn`	Mark as handoff function
`--is-chat-fn`	Mark as chat function
`--is-html-fn`	Mark as HTML function
`--is-database-script`	Mark as database script
`--is-code-template`	Mark as code template
`--chat-action <action>`	Chat action (suggestion
`--hand-off-agent <agentId>`	Agent ID to hand off to
`--hand-off-to-original-agent-on-completion <bool>`	Hand off to original agent on completion (true
`--hand-off-to-original-agent-on-failure <bool>`	Hand off to original agent on failure (true
`--hand-off-agent-on-completion <agentId>`	Agent ID to hand off to on completion
`--hand-off-agent-on-failure <agentId>`	Agent ID to hand off to on failure
`--users-to-hand-off-to <users>`	Comma-separated user IDs to hand off to
`--handed-off-to-human-on-call`	Hand off to human on call
`--agent-skill-script <script>`	Agent skill script
`--chat-script <script>`	Chat script
`--html-url <url>`	HTML URL
`--html-script <script>`	HTML script
`--is-html-redirect-fn`	Mark as HTML redirect function
`--html-form-on-successful-submit-message <msg>`	HTML form success message
`--html-form-on-failed-submit-message <msg>`	HTML form failure message
`--db-connection-id <id>`	Database connection ID
`--db-script <script>`	Database script
`--db-schema-metadata <json>`	Database schema metadata (JSON)
`--pre-execution-script <script>`	Pre-execution script
`--post-execution-script <script>`	Post-execution script
`--pre-execution-fn-id <id>`	Pre-execution function ID
`--pre-execution-mapping <json>`	Pre-execution mapping (JSON)
`--oauth-connection-id <id>`	OAuth connection ID
`--code-execution-environment-id <id>`	Code execution environment ID
`--on-fn-call <json>`	On function call config (JSON)
`--parameters <json>`	Function parameters (JSON)
`--headers <json>`	Headers (JSON)
`--static-args <json>`	Static arguments (JSON)
`--graphql-query <query>`	GraphQL query
`--graphql-mutation <mutation>`	GraphQL mutation
`--graphql-operation-name <name>`	GraphQL operation name
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-function

create-hook

Create a new hook

Options

Flag	Description
`--name <name>`	Hook name
`--url <url>`	Hook URL
`--events <events>`	Events to trigger on (comma-separated)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-hook

create-member

Create a new workspace member

Options

Flag	Description
`--user-id <id>`	User ID (required)
`--role <role>`	Member role (optional)
`--status <status>`	Member status (optional)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-member

create-prompt

Create a new prompt with specified parameters

Arguments

Name	Description
`<type>`	Prompt type
`<label>`	Prompt label
`<prompt-length>`	Prompt length (number)
`<interpolation-string>`	Interpolation string

Options

Flag	Description
`--user-id <id>`	User ID (optional, uses configured value if not provided)
`--scope <scope>`	Prompt scope
`--style <style>`	Prompt style
`--domain <domain>`	Prompt domain
`--prompt-placeholder <placeholder>`	Prompt placeholder
`--available-to-agents <agents>`	Comma-separated agent IDs
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed creation information

toothfairy create-prompt <type> <label> <prompt-length> <interpolation-string>

create-scheduled-job

Create a new scheduled job

Arguments

Name	Description
`[id]`	Scheduled Job ID (optional)

Options

Flag	Description
`--name <name>`	Job name
`--description <desc>`	Job description
`--agent-id <id>`	Agent ID to run
`--custom-prompt-id <id>`	Custom prompt ID
`--forced-prompt <prompt>`	Forced prompt
`--timezone <tz>`	Timezone (default: UTC)
`--frequency <freq>`	Frequency (MINUTES
`--interval <n>`	Interval value
`--cron-expression <expr>`	Cron expression (for CUSTOM frequency)
`--day-of-week <n>`	Day of week (0-6)
`--day-of-month <n>`	Day of month (1-31)
`--hour <n>`	Hour (0-23)
`--minute <n>`	Minute (0-59)
`--start-date <date>`	Start date (ISO format)
`--end-date <date>`	End date (ISO format)
`--timeout <ms>`	Execution timeout in milliseconds
`--max-duration <ms>`	Max execution duration in milliseconds
`--priority <p>`	Priority (CRITICAL
`--input-params <json>`	Input parameters (JSON)
`--webhook-url <url>`	Webhook URL for notifications
`--webhook-headers <json>`	Webhook headers (JSON)
`--notify-on-success`	Notify on success
`--notify-on-failure`	Notify on failure
`--notify-on-start`	Notify on start
`--email-recipients <emails>`	Email recipients (comma-separated)
`--communication-service-id <id>`	Communication service ID
`--max-retries <n>`	Max retry attempts
`--retry-interval <ms>`	Retry interval in milliseconds
`--backoff-multiplier <n>`	Backoff multiplier
`--max-retry-interval <ms>`	Max retry interval in milliseconds
`--metadata <json>`	Additional metadata (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-scheduled-job [id]

create-secret

Create a new secret

Options

Flag	Description
`--name <name>`	Secret name
`--value <value>`	Secret value
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy create-secret

create-trigger

Create a new event-driven agent trigger

Options

Flag	Description
`--name <name>`	Trigger name
`--custom-prompt-id <id>`	Custom prompt ID
`--description <desc>`	Trigger description
`--forced-prompt <prompt>`	Forced prompt text
`--event-config <json>`	Event config as JSON string
`--status <status>`	Trigger status (ARMED
`--metadata <json>`	Metadata JSON string
`-o, --output <format>`	Output format (json

toothfairy create-trigger

delete-agent

Delete an agent

Arguments

Name	Description
`<id>`	Agent ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-agent <id>

delete-authorisation

Delete an authorisation

Arguments

Name	Description
`<id>`	Authorisation ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-authorisation <id>

delete-authorization

Delete an authorization

Arguments

Name	Description
`<id>`	Authorization ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-authorization <id>

delete-benchmark

Delete a benchmark

Arguments

Name	Description
`<id>`	Benchmark ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-benchmark <id>

delete-channel

Delete a channel

Arguments

Name	Description
`<id>`	Channel ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-channel <id>

delete-connection

Delete a connection

Arguments

Name	Description
`<id>`	Connection ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-connection <id>

delete-doc

Delete a document

Arguments

Name	Description
`<document-id>`	ID of the document to delete

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed deletion information

toothfairy delete-doc <document-id>

delete-entity

Delete an entity

Arguments

Name	Description
`<id>`	Entity ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed deletion information

toothfairy delete-entity <id>

delete-folder

Delete a folder

Arguments

Name	Description
`<id>`	Folder ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed deletion information

toothfairy delete-folder <id>

delete-function

Delete a function

Arguments

Name	Description
`<id>`	Function ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-function <id>

delete-hook

Delete a hook

Arguments

Name	Description
`<id>`	Hook ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-hook <id>

delete-member

Delete a member

Arguments

Name	Description
`<id>`	Member ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-member <id>

delete-prompt

Delete a prompt

Arguments

Name	Description
`<id>`	Prompt ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed deletion information

toothfairy delete-prompt <id>

delete-scheduled-job

Delete a scheduled job

Arguments

Name	Description
`<id>`	Scheduled Job ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-scheduled-job <id>

delete-secret

Delete a secret

Arguments

Name	Description
`<id>`	Secret ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-secret <id>

delete-site

Delete a site

Arguments

Name	Description
`<id>`	Site ID

Options

Flag	Description
`--confirm`	Skip confirmation prompt
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy delete-site <id>

delete-trigger

Delete a trigger

Arguments

Name	Description
`<triggerId>`	Trigger ID

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy delete-trigger <triggerId>

download

Download a file from ToothFairy workspace

Options

Flag	Description
`--workspace-id <id>`	Workspace ID (uses config default if not specified)
`--context <context>`	Download context (default: pdf)
`--output-dir <dir>`	Output directory
`--output-name <name>`	Output filename (defaults to original filename)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed download information

toothfairy download

generate-speech

Generate speech audio from text using ToothFairyAI

Arguments

Name	Description
`<text>`	Text to convert to speech

Options

Flag	Description
`--chat-id <id>`	Chat ID for context (optional)
`--last-message-id <id>`	Last message ID for context (optional)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed generation information

toothfairy generate-speech <text>

get-agent

Get details of a specific agent

Arguments

Name	Description
`<id>`	Agent ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-agent <id>

get-authorisation

Get details of a specific authorisation

Arguments

Name	Description
`<id>`	Authorisation ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-authorisation <id>

get-authorization

Get details of a specific authorization

Arguments

Name	Description
`<id>`	Authorization ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-authorization <id>

get-benchmark

Get details of a specific benchmark

Arguments

Name	Description
`<id>`	Benchmark ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-benchmark <id>

get-benchmark-run

Get a benchmark run by ID with score and metadata

Arguments

Name	Description
`<run_id>`	Run ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-benchmark-run <run_id>

get-channel

Get details of a specific channel

Arguments

Name	Description
`<id>`	Channel ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-channel <id>

get-charting-settings

Get charting settings

Arguments

Name	Description
`<id>`	Settings ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-charting-settings <id>

get-connection

Get details of a specific connection

Arguments

Name	Description
`<id>`	Connection ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-connection <id>

get-dictionary

Get dictionary entry

Arguments

Name	Description
`<id>`	Dictionary ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-dictionary <id>

get-doc

Get details of a specific document

Arguments

Name	Description
`<document-id>`	ID of the document to retrieve

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed document information

toothfairy get-doc <document-id>

get-embedding

Get embedding for text

Arguments

Name	Description
`<text>`	Text to get embedding for

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-embedding <text>

get-embeddings-settings

Get embeddings settings

Arguments

Name	Description
`<id>`	Settings ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-embeddings-settings <id>

get-entity

Get details of a specific entity

Arguments

Name	Description
`<id>`	Entity ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-entity <id>

get-folder

Get details of a specific folder

Arguments

Name	Description
`<id>`	Folder ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-folder <id>

get-function

Get details of a specific function

Arguments

Name	Description
`<id>`	Function ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-function <id>

get-hook

Get details of a specific hook

Arguments

Name	Description
`<id>`	Hook ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-hook <id>

get-member

Get details of a specific member

Arguments

Name	Description
`<id>`	Member ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-member <id>

get-prompt

Get details of a specific prompt

Arguments

Name	Description
`<id>`	Prompt ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-prompt <id>

get-request

Get details of a specific request

Arguments

Name	Description
`<id>`	Request ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-request <id>

get-scheduled-job

Get details of a specific scheduled job

Arguments

Name	Description
`<id>`	Scheduled Job ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-scheduled-job <id>

get-site

Get details of a specific site

Arguments

Name	Description
`<id>`	Site ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-site <id>

get-stream

Get details of a specific stream

Arguments

Name	Description
`<id>`	Stream ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy get-stream <id>

get-trigger

Get a specific trigger by ID

Arguments

Name	Description
`<triggerId>`	Trigger ID

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy get-trigger <triggerId>

help-guide

Show detailed help and usage examples

toothfairy help-guide

list-agents

List all agents

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-agents

list-authorisations

List all authorisations

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-authorisations

list-authorizations

List all authorizations

Options

Flag	Description
`--limit <number>`	Maximum number to return
`--offset <number>`	Number to skip
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-authorizations

list-benchmark-runs

List benchmark runs for the workspace

Options

Flag	Description
`--agent-id <id>`	Filter by agent ID
`--benchmark-id <id>`	Filter by benchmark ID
`--type <type>`	Filter by type (bm
`--status <status>`	Filter by status
`--limit <n>`	Maximum runs to return
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-benchmark-runs

list-benchmarks

List all benchmarks

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-benchmarks

list-channels

List all channels

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-channels

list-connections

List all connections

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-connections

list-dictionaries

List all dictionaries

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-dictionaries

list-entities

List all entities in the workspace

Options

Flag	Description
`--type <type>`	Filter by entity type (intent
`--limit <number>`	Maximum number of entities to return
`--offset <number>`	Number of entities to skip
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-entities

list-folders

List all folders in the workspace

Options

Flag	Description
`--status <status>`	Filter by folder status
`--limit <number>`	Maximum number of folders to return
`--offset <number>`	Number of folders to skip
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-folders

list-functions

List all functions

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-functions

list-hooks

List all hooks

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-hooks

list-members

List all members

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-members

list-messages-bychat

List all messages in a specific chat

Arguments

Name	Description
`<chat-id>`	Chat ID to retrieve messages from

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy list-messages-bychat <chat-id>

list-prompts

List all prompts in the workspace

Options

Flag	Description
`--type <type>`	Filter by prompt type
`--limit <number>`	Maximum number of prompts to return
`--offset <number>`	Number of prompts to skip
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-prompts

list-requests

List all requests

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-requests

list-scheduled-jobs

List all scheduled jobs

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-scheduled-jobs

list-scheduled-jobs-by-status

List scheduled jobs filtered by status

Arguments

Name	Description
`<status>`	Status to filter by (ACTIVE

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-scheduled-jobs-by-status <status>

list-sites

List all sites

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-sites

list-streams

List all streams

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy list-streams

list-triggers

List all triggers in the workspace

Options

Flag	Description
`--limit <n>`	Maximum number of triggers to return
`--offset <n>`	Number of triggers to skip
`-o, --output <format>`	Output format (json

toothfairy list-triggers

migrate

Migrate an agent from one profile to another

Options

Flag	Description
`-s, --source <profile>`	Source profile (required)
`-d, --destination <profile>`	Destination profile (required)
`--id <id>`	Agent ID to migrate
`--name <name>`	Agent name/label to migrate
`--force`	Update existing agent without prompting
`--dry-run`	Show what would be migrated without making changes
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy migrate

pause-scheduled-job

Pause a scheduled job

Arguments

Name	Description
`<id>`	Scheduled Job ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy pause-scheduled-job <id>

pause-trigger

Pause (disarm) a trigger

Arguments

Name	Description
`<triggerId>`	Trigger ID

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy pause-trigger <triggerId>

predict

Generate streaming AI predictions (OpenAI-compatible) from a ToothFairyAI model

Arguments

Name	Description
`<message>`	Message text to send to the model

Options

Flag	Description
`--system <prompt>`	Optional system message
`--message-role <role>`	Role of the message argument (default: user)
`--max-tokens <n>`	Maximum tokens to generate
`--temperature <n>`	Sampling temperature (0-2)
`--top-p <n>`	Nucleus sampling (0-1)
`--top-k <n>`	Top-K sampling
`--repetition-penalty <n>`	Repetition penalty (default 1.0)
`--frequency-penalty <n>`	Frequency penalty (-2 to 2)
`--presence-penalty <n>`	Presence penalty (-2 to 2)
`--stop <sequences>`	Stop sequence(s), comma-separated
`--seed <n>`	Deterministic sampling seed
`--reasoning-mode <mode>`	Reasoning mode: always
`--reasoning-budget <n>`	Max tokens for thinking
`--reasoning-effort <effort>`	Reasoning effort: low
`--response-format <json>`	OpenAI response_format as JSON string
`--verbosity <v>`	Output verbosity: low
`--user <id>`	End-user identifier for tracking
`--region <r>`	Provider pool region: global
`--tools <json>`	OpenAI-format tools JSON string
`--tool-choice <choice>`	auto
`--workspace-id <id>`	Override workspace id (deprecated; resolved from api key by default)
`-o, --output <format>`	Output format (json

toothfairy predict <message>

process-audio

Process audio file and generate text using ToothFairyAI

Arguments

Name	Description
`<audio-file-path>`	Path/URL to the audio file (e.g.,

Options

Flag	Description
`--diarisation`	Enable speaker diarisation (disabled by default)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed processing information

toothfairy process-audio <audio-file-path>

profile

Show profiles, switch to, or delete a profile

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-d, --delete <name>`	Delete a profile

toothfairy profile

resume-scheduled-job

Resume a paused scheduled job

Arguments

Name	Description
`<id>`	Scheduled Job ID

Options

Flag	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy resume-scheduled-job <id>

resume-trigger

Resume (arm) a paused trigger

Arguments

Name	Description
`<triggerId>`	Trigger ID

Options

Flag	Description
`-o, --output <format>`	Output format (json

toothfairy resume-trigger <triggerId>

run-benchmark

Start a benchmark run to evaluate an agent

Arguments

Name	Description
`<benchmark_id>`	Benchmark ID
`<agent_id>`	Agent ID

Options

Flag	Description
`--type <type>`	Run type: bm or abm
`--mode <mode>`	ABM mode: static or dynamic
`--name <name>`	Optional name for the run
`--passing-score <score>`	Minimum score to pass (0-1)
`--num-questions <n>`	Number of questions to use
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy run-benchmark <benchmark_id> <agent_id>

search

Search for documents in the knowledge hub

Arguments

Name	Description
`<query>`	search query text

Options

Flag	Description
`-k, --top-k <number>`	Number of documents to retrieve (1-50)
`--status <status>`	Filter by document status (published
`--document-id <id>`	Search within specific document ID
`--topics <topics>`	Comma-separated topic IDs to filter by
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed search information

toothfairy search <query>

send

Send a message to a ToothFairyAI agent

Arguments

Name	Description
`<message>`	message to send

Options

Flag	Description
`--agent-id <id>`	Agent ID to send message to (uses default if configured)
`--chat-id <id>`	Chat ID to use existing conversation (optional)
`--phone-number <number>`	Phone number for SMS channel
`--customer-id <id>`	Customer ID
`--provider-id <id>`	SMS provider ID
`--customer-info <json>`	Customer info as JSON string
`--image <path>`	Path to image file (png, jpg, jpeg, gif, bmp, svg)
`--audio <path>`	Path to audio file (wav, mp3, aac, ogg, flac)
`--video <path>`	Path to video file (mp4, avi, mov, wmv, flv, webm)
`--file <path...>`	Path to document files (max 5)
`--local-file <path...>`	Path to local files to include (text files embedded in message, binary files uploaded)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed response information

toothfairy send <message>

send-stream

Send a message to a ToothFairyAI agent with real-time streaming response

Arguments

Name	Description
`<message>`	message to send

Options

Flag	Description
`--agent-id <id>`	Agent ID to send message to (uses default if configured)
`--chat-id <id>`	Chat ID to use existing conversation (optional)
`--phone-number <number>`	Phone number for SMS channel
`--customer-id <id>`	Customer ID
`--provider-id <id>`	SMS provider ID
`--customer-info <json>`	Customer info as JSON string
`--image <path>`	Path to image file (PNG, max 1)
`--audio <path>`	Path to audio file (WAV, max 1)
`--video <path>`	Path to video file (MP4, max 1)
`--file <path>`	Path to file (max 5, can be used multiple times)
`--local-file <path...>`	Path to local files to include (text files embedded in message, binary files uploaded)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed streaming information
`--show-progress`	Show agent processing status updates

toothfairy send-stream <message>

setup

Create or update a tfcode profile in ~/.tfcode/profiles.json

Options

Flag	Description
`--name <name>`	Profile name
`--api-key <key>`	API key
`--workspace-id <id>`	Workspace ID
`--region <region>`	Region (dev, au, eu, us)

toothfairy setup

update-agent

Update an existing agent

Arguments

Name	Description
`<id>`	Agent ID

Options

Flag	Description
`--label <label>`	Agent label
`--description <description>`	Agent description
`--emoji <emoji>`	Agent emoji
`--mode <mode>`	Agent mode
`--agent-type <type>`	Agent type (Chatbot
`--llm-provider <provider>`	LLM provider name
`--llm-base-model <model>`	LLM base model name
`--llm-url <url>`	LLM URL endpoint
`--reasoning-mode <mode>`	Reasoning mode (auto
`--reasoning-effort <effort>`	Reasoning effort (none
`--fn-reasoning-effort <effort>`	Function reasoning effort (none
`--voice-name <name>`	Voice name for voice agents
`--agents-pool <ids>`	Comma-separated agent IDs for agents pool
`--mcps <ids>`	Comma-separated MCP IDs
`--rag-search-strategy <strategy>`	RAG search strategy (parallel
`--re-rag <bool>`	Enable re-ranking for RAG (true
`--internet-search-modes <modes>`	Comma-separated internet search modes
`--sip-phone-number <number>`	SIP phone number
`--sip-dispatch-rule-id <id>`	SIP dispatch rule ID
`--enable-inbound-sip <bool>`	Enable inbound SIP (true
`--enable-outbound-sip <bool>`	Enable outbound SIP (true
`--temperature <temp>`	Temperature (0.0-2.0)
`--max-tokens <tokens>`	Max tokens
`--max-history <history>`	Max conversation history
`--top-k <k>`	Top K for retrieval
`--doc-top-k <k>`	Document top K
`--interpolation-string <string>`	System prompt template
`--goals <goals>`	Agent goals
`--department <dept>`	Department
`--allow-images-upload <bool>`	Allow image uploads (true
`--allow-videos-upload <bool>`	Allow video uploads (true
`--allow-audios-upload <bool>`	Allow audio uploads (true
`--allow-docs-upload <bool>`	Allow document uploads (true
`--allow-internet-search <bool>`	Allow internet search (true
`--agentic-rag <bool>`	Enable agentic RAG (true
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-agent <id>

update-authorisation

Update an existing authorisation

Arguments

Name	Description
`<id>`	Authorisation ID

Options

Flag	Description
`--name <name>`	Authorisation name
`--permissions <permissions>`	Permissions (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-authorisation <id>

update-authorization

Update an existing authorization

Options

Flag	Description
`--id <id>`	Authorization ID
`--name <name>`	Authorization name
`--type <type>`	Authorization type
`--config <config>`	Authorization configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-authorization

update-benchmark

Update an existing benchmark

Arguments

Name	Description
`<id>`	Benchmark ID

Options

Flag	Description
`--name <name>`	Benchmark name
`--description <description>`	Benchmark description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-benchmark <id>

update-channel

Update an existing channel

Arguments

Name	Description
`<id>`	Channel ID

Options

Flag	Description
`--name <name>`	Channel name
`--type <type>`	Channel type
`--config <config>`	Channel configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-channel <id>

update-charting-settings

Update charting settings

Arguments

Name	Description
`<id>`	Settings ID

Options

Flag	Description
`--config <config>`	Settings configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-charting-settings <id>

update-connection

Update an existing connection

Arguments

Name	Description
`<id>`	Connection ID

Options

Flag	Description
`--name <name>`	Connection name
`--type <type>`	Hosting type
`--endpoint <url>`	API endpoint URL
`--model-name <name>`	Model name
`--base-model <model>`	Base model
`--custom-model <bool>`	Mark as custom model (true
`--api-version <version>`	API version
`--token-secret <secret>`	Token secret reference
`--description <desc>`	Description
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-connection <id>

update-doc

Update an existing document

Arguments

Name	Description
`<document-id>`	ID of the document to update

Options

Flag	Description
`--type <type>`	Document type
`--rawtext <text>`	Raw text content
`--title <title>`	Document title
`--status <status>`	Document status (draft
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed update information

toothfairy update-doc <document-id>

update-embeddings-settings

Update embeddings settings

Arguments

Name	Description
`<id>`	Settings ID

Options

Flag	Description
`--config <config>`	Settings configuration (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-embeddings-settings <id>

update-entity

Update an existing entity

Arguments

Name	Description
`<id>`	Entity ID

Options

Flag	Description
`--label <label>`	New entity label
`--type <type>`	New entity type (intent
`--description <desc>`	New entity description
`--emoji <emoji>`	New entity emoji
`--parent-entity <id>`	New parent entity ID
`--background-color <color>`	New background color (hex format)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed update information

toothfairy update-entity <id>

update-folder

Update an existing folder

Arguments

Name	Description
`<id>`	Folder ID

Options

Flag	Description
`--name <name>`	New folder name
`--description <desc>`	New folder description
`--emoji <emoji>`	New folder emoji
`--status <status>`	New folder status
`--parent <id>`	New parent folder ID
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed update information

toothfairy update-folder <id>

update-function

Update an existing function

Arguments

Name	Description
`<id>`	Function ID

Options

Flag	Description
`--name <name>`	Function name
`--description <description>`	Function description
`--code <code>`	Function code
`--url <url>`	Function URL endpoint
`--request-type <type>`	Request type
`--authorisation-type <type>`	Authorisation type
`--scope <scope>`	Function scope
`--is-mcp-server <bool>`	Mark as MCP server (true
`--is-agent-skill <bool>`	Mark as agent skill (true
`--is-callback-fn <bool>`	Mark as callback function (true
`--is-hand-off-fn <bool>`	Mark as handoff function (true
`--is-chat-fn <bool>`	Mark as chat function (true
`--is-html-fn <bool>`	Mark as HTML function (true
`--is-database-script <bool>`	Mark as database script (true
`--is-code-template <bool>`	Mark as code template (true
`--chat-action <action>`	Chat action
`--hand-off-agent <agentId>`	Agent ID to hand off to
`--hand-off-to-original-agent-on-completion <bool>`	Hand off to original agent on completion (true
`--hand-off-to-original-agent-on-failure <bool>`	Hand off to original agent on failure (true
`--hand-off-agent-on-completion <agentId>`	Agent ID to hand off to on completion
`--hand-off-agent-on-failure <agentId>`	Agent ID to hand off to on failure
`--users-to-hand-off-to <users>`	Comma-separated user IDs to hand off to
`--handed-off-to-human-on-call <bool>`	Hand off to human on call (true
`--agent-skill-script <script>`	Agent skill script
`--chat-script <script>`	Chat script
`--html-url <url>`	HTML URL
`--html-script <script>`	HTML script
`--is-html-redirect-fn <bool>`	Mark as HTML redirect function (true
`--html-form-on-successful-submit-message <msg>`	HTML form success message
`--html-form-on-failed-submit-message <msg>`	HTML form failure message
`--db-connection-id <id>`	Database connection ID
`--db-script <script>`	Database script
`--db-schema-metadata <json>`	Database schema metadata (JSON)
`--pre-execution-script <script>`	Pre-execution script
`--post-execution-script <script>`	Post-execution script
`--pre-execution-fn-id <id>`	Pre-execution function ID
`--pre-execution-mapping <json>`	Pre-execution mapping (JSON)
`--oauth-connection-id <id>`	OAuth connection ID
`--code-execution-environment-id <id>`	Code execution environment ID
`--on-fn-call <json>`	On function call config (JSON)
`--parameters <json>`	Function parameters (JSON)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-function <id>

update-hook

Update an existing hook

Arguments

Name	Description
`<id>`	Hook ID

Options

Flag	Description
`--name <name>`	Hook name
`--url <url>`	Hook URL
`--events <events>`	Events to trigger on (comma-separated)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-hook <id>

update-member

Update a member

Arguments

Name	Description
`<id>`	Member ID

Options

Flag	Description
`--name <name>`	Member name
`--email <email>`	Member email
`--role <role>`	Member role
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-member <id>

update-prompt

Update an existing prompt

Arguments

Name	Description
`<id>`	Prompt ID

Options

Flag	Description
`--type <type>`	New prompt type
`--label <label>`	New prompt label
`--prompt-length <length>`	New prompt length (number)
`--interpolation-string <string>`	New interpolation string
`--scope <scope>`	New prompt scope
`--style <style>`	New prompt style
`--domain <domain>`	New prompt domain
`--prompt-placeholder <placeholder>`	New prompt placeholder
`--available-to-agents <agents>`	New comma-separated agent IDs
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed update information

toothfairy update-prompt <id>

update-scheduled-job

Update an existing scheduled job

Arguments

Name	Description
`<id>`	Scheduled Job ID

Options

Flag	Description
`--name <name>`	Job name
`--description <desc>`	Job description
`--agent-id <id>`	Agent ID to run
`--custom-prompt-id <id>`	Custom prompt ID
`--forced-prompt <prompt>`	Forced prompt
`--timezone <tz>`	Timezone
`--frequency <freq>`	Frequency (MINUTES
`--interval <n>`	Interval value
`--cron-expression <expr>`	Cron expression (for CUSTOM frequency)
`--day-of-week <n>`	Day of week (0-6)
`--day-of-month <n>`	Day of month (1-31)
`--hour <n>`	Hour (0-23)
`--minute <n>`	Minute (0-59)
`--start-date <date>`	Start date (ISO format)
`--end-date <date>`	End date (ISO format)
`--timeout <ms>`	Execution timeout in milliseconds
`--max-duration <ms>`	Max execution duration in milliseconds
`--priority <p>`	Priority (CRITICAL
`--input-params <json>`	Input parameters (JSON)
`--webhook-url <url>`	Webhook URL for notifications
`--webhook-headers <json>`	Webhook headers (JSON)
`--notify-on-success`	Notify on success
`--notify-on-failure`	Notify on failure
`--notify-on-start`	Notify on start
`--email-recipients <emails>`	Email recipients (comma-separated)
`--communication-service-id <id>`	Communication service ID
`--max-retries <n>`	Max retry attempts
`--retry-interval <ms>`	Retry interval in milliseconds
`--backoff-multiplier <n>`	Backoff multiplier
`--max-retry-interval <ms>`	Max retry interval in milliseconds
`--metadata <json>`	Additional metadata (JSON)
`--is-active <bool>`	Is active (true
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-scheduled-job <id>

update-site

Update a site

Arguments

Name	Description
`<id>`	Site ID

Options

Flag	Description
`--name <name>`	Site name
`--url <url>`	Site URL
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed information

toothfairy update-site <id>

update-trigger

Update an existing trigger

Arguments

Name	Description
`<triggerId>`	Trigger ID

Options

Flag	Description
`--name <name>`	Trigger name
`--agent-id <id>`	Agent ID
`--description <desc>`	Description
`--forced-prompt <prompt>`	Forced prompt text
`--is-active <bool>`	Arm (true) or disarm (false)
`--status <status>`	Status (ARMED
`--metadata <json>`	Metadata JSON string
`-o, --output <format>`	Output format (json

toothfairy update-trigger <triggerId>

upload

Upload a file to ToothFairy workspace

Arguments

Name	Description
`<file-path>`	Path to file to upload

Options

Flag	Description
`--import-type <type>`	Import type (optional, auto-detected from extension)
`--content-type <type>`	Content type (optional, auto-detected from extension)
`-o, --output <format>`	Output format (json
`-v, --verbose`	Show detailed upload information

toothfairy upload <file-path>

validate

Validate ToothFairyAI credentials

toothfairy validate

Index​

billing​

billing-month-costs​

cancel-benchmark-run​

chat​

chats​

config-show​

configure​

create-agent​

create-authorisation​

create-authorization​

create-benchmark​

create-channel​

create-connection​

create-doc​

create-entity​

create-folder​

create-function​

create-hook​

create-member​

create-prompt​

create-scheduled-job​

create-secret​

create-trigger​

delete-agent​

delete-authorisation​

delete-authorization​

delete-benchmark​

delete-channel​

delete-connection​

delete-doc​

delete-entity​

delete-folder​

delete-function​

delete-hook​

delete-member​

delete-prompt​

delete-scheduled-job​

delete-secret​

delete-site​

delete-trigger​

download​

generate-speech​

get-agent​

get-authorisation​

get-authorization​

get-benchmark​

get-benchmark-run​

get-channel​

get-charting-settings​

get-connection​

get-dictionary​

get-doc​

get-embedding​

get-embeddings-settings​

get-entity​

get-folder​

get-function​

get-hook​

get-member​

get-prompt​

get-request​

get-scheduled-job​

get-site​

get-stream​

get-trigger​

help-guide​

list-agents​

list-authorisations​

list-authorizations​

list-benchmark-runs​

list-benchmarks​

list-channels​

list-connections​

list-dictionaries​

list-entities​

list-folders​

list-functions​

list-hooks​

list-members​

Index

billing

billing-month-costs

cancel-benchmark-run

chat

chats

config-show

configure

create-agent

create-authorisation

create-authorization

create-benchmark

create-channel

create-connection

create-doc

create-entity

create-folder

create-function

create-hook

create-member

create-prompt

create-scheduled-job

create-secret

create-trigger

delete-agent

delete-authorisation

delete-authorization

delete-benchmark

delete-channel

delete-connection

delete-doc

delete-entity

delete-folder

delete-function

delete-hook

delete-member

delete-prompt

delete-scheduled-job

delete-secret

delete-site

delete-trigger

download

generate-speech

get-agent

get-authorisation

get-authorization

get-benchmark

get-benchmark-run

get-channel

get-charting-settings

get-connection

get-dictionary

get-doc

get-embedding

get-embeddings-settings

get-entity

get-folder

get-function

get-hook

get-member

get-prompt

get-request

get-scheduled-job

get-site

get-stream

get-trigger

help-guide

list-agents

list-authorisations

list-authorizations

list-benchmark-runs

list-benchmarks

list-channels

list-connections

list-dictionaries

list-entities

list-folders

list-functions

list-hooks

list-members