Docs
Open SmallForce

CLI

SmallForce CLI: Calls commands

Manage assistants, publishing, personal audio/video links, numbers and call history

This page covers 73 smallforce calls commands. It is generated from SmallForce CLI 0.1.17; run smallforce calls --help (or any command with --help) to see the same reference for the version you have installed. New to the CLI? Start with installation and authentication and JSON output.

Examples:
  smallforce calls assistants schema --mode standalone --json
  smallforce calls voices list --json
  smallforce calls video catalog --json
  smallforce calls assistants list --json
  smallforce calls assistants create --mode standalone --name Receptionist --system-prompt-file ./receptionist.md
  smallforce calls phone-numbers search --country-code US
  smallforce calls phone-numbers buy --phone-number <number> --purchase-id <uuid> --assistant-id <id>
  smallforce calls knowledge train-text --assistant-id <id> --content-file ./business.txt
  smallforce calls list --limit 20 --json
  smallforce calls list --since 7d --number +15125550147 --json
  smallforce calls stats --range 7d --json
  smallforce calls needs-you --json
  smallforce calls needs-you done call <callId> --json
  smallforce calls get <callId> --json
  smallforce calls handoff <callId> --json
  smallforce calls recording <callId> --json
  smallforce calls publish get <assistantId> --json
  smallforce calls publish install <assistantId> --json
  smallforce calls links create --assistant-id <id> --title Onboarding --modes audio --expires-in 7d --idempotency-key onboarding-42 --json
  smallforce calls answers <callId> --json
  smallforce calls callers get +15125550147 --json
  smallforce calls memory add +15125550147 --content "Prefers texts" --kind profile --json

Purchases, renewals and call usage are billed by the existing voice service.

Common options

Most commands accept these options as well as their own. Every command also accepts -h, --help.

OptionDescription
--api-key <key>SmallForce API key, or set SMALLFORCE_API_KEY
--backend-url <url>SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
--jsonPrint stable machine-readable JSON
--textPrint human-readable text
--format <format>Output format: text or json

smallforce calls credits

Show the existing SmallForce credit balance

Usage: smallforce calls credits [options]

Also accepts the common options listed at the top of this page.

smallforce calls list

List call history, newest first

Usage: smallforce calls list [options]

OptionDescription
--assistant-id <id>Filter by voice assistant
--channel <channel>Filter channel (choices: “phone”, “web”)
--cursor <cursor>Opaque nextCursor from the previous page
--since <time>Only calls created at or after this time: an ISO-8601 timestamp, or a duration ago such as 30m, 12h or 7d
--until <time>Only calls created before this time: an ISO-8601 timestamp, or a duration ago such as 30m, 12h or 7d
--number <e164>Only calls from this caller number, E.164 (for example +15125550147)
--include-testsInclude test calls from the assistant builder
--limit <number>Maximum calls (1-200)
--status <statuses...>Filter call statuses (choices: “created”, “connecting”, “active”, “ending”, “call_completed”, “recording_processing”, “transcript_finalizing”, “completed”, “failed”, “rejected”, “expired”)

Also accepts the common options listed at the top of this page.

smallforce calls get

Get a call with events, transcripts, recording and follow-up (hand-off and website forms)

Usage: smallforce calls get [options] <callId>

ArgumentDescription
callId—
OptionDescription
--event-limit <number>Maximum events (1-5000)
--transcript-limit <number>Maximum transcript entries (1-5000)

Also accepts the common options listed at the top of this page.

smallforce calls events

Read the call’s lifecycle events

Usage: smallforce calls events [options] <callId>

ArgumentDescription
callId—
OptionDescription
--limit <number>Maximum events (1-5000)

Also accepts the common options listed at the top of this page.

smallforce calls transcripts

Read call transcripts

Usage: smallforce calls transcripts [options] <callId>

ArgumentDescription
callId—
OptionDescription
--limit <number>Maximum transcript entries (1-5000)

Also accepts the common options listed at the top of this page.

smallforce calls recording

Get the existing recording’s temporary playback URL, when available

Usage: smallforce calls recording [options] <callId>

ArgumentDescription
callId—

Also accepts the common options listed at the top of this page.

smallforce calls handoff

Read a call’s hand-off: who was rung, who declined or joined

Usage: smallforce calls handoff [options] <callId>

ArgumentDescription
callId—

Also accepts the common options listed at the top of this page.

smallforce calls stats

Count calls per hour today, or per day over 7 or 30 days

Usage: smallforce calls stats [options]

OptionDescription
--range <range>today (per hour), 7d or 30d (per day); default today (choices: “today”, “7d”, “30d”)
--time-zone <zone>IANA time zone for the hours and days; default the business’s own

Also accepts the common options listed at the top of this page.

smallforce calls needs-you

List calls that need someone: missed, failed and unanswered

Usage: smallforce calls needs-you [options] [command]

OptionDescription
--days <number>How far back to look, in days (1-30, default 7)

Also accepts the common options listed at the top of this page.

smallforce calls needs-you done

Clear a Needs you item for the whole team

Usage: smallforce calls needs-you done [options] <kind> <id>

ArgumentDescription
kind—
id—

Also accepts the common options listed at the top of this page.

smallforce calls voices

Discover the voice service’s TTS voice catalog

smallforce calls voices list

List available TTS voices

Usage: smallforce calls voices list [options]

OptionDescription
--provider <provider>Voice provider (choices: “deepgram”, “openai”, “google”, “rime”, “phonic”, “cartesia”)
--language <language>Filter language
--search <text>Search voices
--limit <number>Maximum voices (1-1000)

Also accepts the common options listed at the top of this page.

smallforce calls voices languages

List languages available in the voice catalog

Usage: smallforce calls voices languages [options]

OptionDescription
--provider <provider>Voice provider (choices: “deepgram”, “openai”, “google”, “rime”, “phonic”, “cartesia”)

Also accepts the common options listed at the top of this page.

smallforce calls publish

Configure regular assistants’ public pages and website embeds

smallforce calls publish get

Read publishing settings, embed experience and collection fields

Usage: smallforce calls publish get [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

smallforce calls publish update

Patch publishing settings; omitted fields are preserved and experience is replaced as a whole

Usage: smallforce calls publish update [options] <assistantId>

ArgumentDescription
assistantId—
OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls publish install

Get the public URL, floating widget and inline snippets with availability settings

Usage: smallforce calls publish install [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

Manage personalized audio/video call invitations for regular assistants

Create a personal call link; reuse the idempotency key and input for retries

Usage: smallforce calls links create [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--assistant-id <id>Configured regular assistant
--publication-id <id>Saved design for this assistant (defaults to its default design)
--title <title>Call title
--recipient-name <name>Recipient display name
--recipient-email <email>Email used for optional verification
--customer-reference <reference>Your customer identifier
--context <content>Private background for this conversation
--context-file <path>Read private context from a file, or - for stdin
--modes <modes...>Allowed call modes (choices: “audio”, “video”)
--expires-at <timestamp>ISO timestamp including timezone, within 90 days
--expires-in <duration>Relative expiry such as 30m, 12h or 7d
--verify-emailRequire email verification before the call
--idempotency-key <key>Stable key for this creation request (required in flags or JSON)

Also accepts the common options listed at the top of this page.

List link summaries and related calls; private context and bearer URLs are omitted

Usage: smallforce calls links list [options]

OptionDescription
--assistant-id <id>Filter assistant
--customer-reference <reference>Filter exact customer reference
--status <status>Expiry/revocation state; unexpired links may already have a conversation (choices: “unexpired”, “expired”, “revoked”)
--limit <number>Page size (1-100)
--cursor <cursor>Opaque nextCursor from the previous page

Also accepts the common options listed at the top of this page.

Get link details including private context

Usage: smallforce calls links get [options] <linkId>

ArgumentDescription
linkId—

Also accepts the common options listed at the top of this page.

Explicitly retrieve the private bearer URL

Usage: smallforce calls links url [options] <linkId>

ArgumentDescription
linkId—

Also accepts the common options listed at the top of this page.

Revoke a personalized invitation

Usage: smallforce calls links revoke [options] <linkId>

ArgumentDescription
linkId—

Also accepts the common options listed at the top of this page.

smallforce calls answers

Read collected answers, field definitions and missing required fields

Usage: smallforce calls answers [options] <callId>

ArgumentDescription
callId—

Also accepts the common options listed at the top of this page.

smallforce calls video

Discover available video avatars and voices

smallforce calls video catalog

List available video catalog, defaults and duration limits

Usage: smallforce calls video catalog [options]

OptionDescription
--assistant-id <id>Include saved settings for a standalone or AI employee assistant
--provider <provider>Filter the video provider (choices: “tavus”, “anam”)
--search <text>Filter avatar and voice names

Also accepts the common options listed at the top of this page.

smallforce calls video avatars

List available video avatars, defaults and duration limits

Usage: smallforce calls video avatars [options]

OptionDescription
--assistant-id <id>Include saved settings for a standalone or AI employee assistant
--provider <provider>Filter the video provider (choices: “tavus”, “anam”)
--search <text>Filter avatar and voice names

Also accepts the common options listed at the top of this page.

smallforce calls video voices

List available video voices, defaults and duration limits

Usage: smallforce calls video voices [options]

OptionDescription
--assistant-id <id>Include saved settings for a standalone or AI employee assistant
--provider <provider>Filter the video provider (choices: “tavus”, “anam”)
--search <text>Filter avatar and voice names

Also accepts the common options listed at the top of this page.

smallforce calls assistants

Manage voice assistant configuration

smallforce calls assistants fields

Manage information a regular assistant collects naturally during calls

smallforce calls assistants fields get

Read collection field definitions

Usage: smallforce calls assistants fields get [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

smallforce calls assistants fields set

Replace field definitions using {“fields”:[…]}; an empty array disables collection

Usage: smallforce calls assistants fields set [options] <assistantId>

ArgumentDescription
assistantId—
OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls assistants schema

Describe every create/update setting, defaults, restrictions and related call settings

Usage: smallforce calls assistants schema [options]

OptionDescription
--mode <mode>Assistant mode (choices: “standalone”, “ai_employee”, default: “standalone”)

Also accepts the common options listed at the top of this page.

smallforce calls assistants list

List voice assistants

Usage: smallforce calls assistants list [options]

OptionDescription
--include-deletedInclude deleted assistants
--limit <number>Maximum assistants (1-250)
--status <statuses...>Filter statuses (choices: “draft”, “active”, “paused”, “archived”)

Also accepts the common options listed at the top of this page.

smallforce calls assistants create

Create a standalone or AI employee voice assistant

Usage: smallforce calls assistants create [options]

OptionDescription
--mode <mode>Assistant mode (choices: “standalone”, “ai_employee”)
--employee-os <id>Employee OS instance
--employee-profile <slug>Employee profile
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--max-duration-seconds <seconds>Assistant call duration ceiling
--name <name>Assistant name
--progress <mode>Spoken progress level (choices: “final_only”, “compact”, “detailed”)
--status <status>Assistant status (choices: “draft”, “active”, “paused”, “archived”)
--system-prompt <text>Instructions used by the voice assistant
--system-prompt-file <path>Read instructions from a file, or - for stdin
--time-zone <iana>Time zone the receptionist speaks in, e.g. America/New_York (standalone only; defaults to the organization’s)

Also accepts the common options listed at the top of this page.

smallforce calls assistants get

Get a voice assistant and its settings

Usage: smallforce calls assistants get [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

smallforce calls assistants update

Update selected assistant settings

Usage: smallforce calls assistants update [options] <assistantId>

ArgumentDescription
assistantId—
OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--max-duration-seconds <seconds>Assistant call duration ceiling
--name <name>Assistant name
--progress <mode>Spoken progress level (choices: “final_only”, “compact”, “detailed”)
--status <status>Assistant status (choices: “draft”, “active”, “paused”, “archived”)
--system-prompt <text>Instructions used by the voice assistant
--system-prompt-file <path>Read instructions from a file, or - for stdin
--time-zone <iana>Time zone the receptionist speaks in, e.g. America/New_York (standalone only; defaults to the organization’s)

Also accepts the common options listed at the top of this page.

smallforce calls assistants delete

Soft-delete a voice assistant

Usage: smallforce calls assistants delete [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers

Search, purchase and manage inbound phone numbers

smallforce calls phone-numbers incoming

Inspect or replace incoming-call routing, hours and recipients

smallforce calls phone-numbers incoming get

Get saved settings and valid recipient IDs

Usage: smallforce calls phone-numbers incoming get [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers incoming set

Replace routing settings; inspect incoming get and assistants schema first

Usage: smallforce calls phone-numbers incoming set [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—
OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin

Also accepts the common options listed at the top of this page.

Search available phone numbers

Usage: smallforce calls phone-numbers search [options]

OptionDescription
--country-code <code>Two-letter country code
--area-code <code>Area code
--contains <digits>Digits to match
--limit <number>Maximum results (1-150)

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers quote

Show what buying a number costs: the plan’s free US/Canada number, or an extra number

Usage: smallforce calls phone-numbers quote [options]

OptionDescription
--country-code <code>Two-letter country code
--phone-number <number>E.164 number from search, to check its country exactly

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers list

List purchased phone numbers and their billing status

Usage: smallforce calls phone-numbers list [options]

OptionDescription
--include-deletedInclude released numbers

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers buy

Purchase a phone number; the plan’s first US/Canada number is free, extras are charged (run quote first)

Usage: smallforce calls phone-numbers buy [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--phone-number <number>E.164 phone number returned by search
--purchase-id <uuid>Purchase UUID; reuse it for every retry of this purchase
--assistant-id <id>Voice assistant to attach
--friendly-name <name>Display name
--country-code <code>Two-letter country code

Also accepts the common options listed at the top of this page.

Create a purchase UUID once (for example, uuidgen) and reuse it if the request fails or times out.

smallforce calls phone-numbers get

Get a purchased phone number

Usage: smallforce calls phone-numbers get [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—
OptionDescription
--include-deletedInclude a released number

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers attach

Attach a purchased number to a voice assistant

Usage: smallforce calls phone-numbers attach [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—
OptionDescription
--assistant-id <id>Voice assistant ID

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers detach

Detach a number from its assistant; keep the purchased number

Usage: smallforce calls phone-numbers detach [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers sync-webhooks

Sync the service’s current voice webhooks to the provider

Usage: smallforce calls phone-numbers sync-webhooks [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—

Also accepts the common options listed at the top of this page.

smallforce calls phone-numbers delete

Release the number with the provider and mark it deleted

Usage: smallforce calls phone-numbers delete [options] <phoneNumberId>

ArgumentDescription
phoneNumberId—

Also accepts the common options listed at the top of this page.

smallforce calls knowledge

Manage the existing voice knowledge and training jobs

smallforce calls knowledge list

List an assistant’s knowledge and training status

Usage: smallforce calls knowledge list [options]

OptionDescription
--assistant-id <id>Voice assistant ID
--include-deletedInclude deleted knowledge
--limit <number>Maximum results (1-500)
--status <statuses...>Filter training statuses (choices: “DRAFT”, “PENDING”, “IN_PROGRESS”, “EXTRACTED”, “TRAINED”, “FAILED”, “DELETED”, “DELETION_ERROR”)
--type <types...>Filter knowledge types (choices: “TEXT”, “URL”, “PDF”)

Also accepts the common options listed at the top of this page.

smallforce calls knowledge get

Get knowledge content and current training status

Usage: smallforce calls knowledge get [options] <knowledgeId>

ArgumentDescription
knowledgeId—
OptionDescription
--include-deletedInclude deleted knowledge

Also accepts the common options listed at the top of this page.

smallforce calls knowledge train-text

Submit text to the existing training queue

Usage: smallforce calls knowledge train-text [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--assistant-id <id>Voice assistant ID
--name <name>Knowledge name
--content <text>Text to train
--content-file <path>Read text from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls knowledge train-url

Submit a URL to the existing training queue

Usage: smallforce calls knowledge train-url [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--assistant-id <id>Voice assistant ID
--url <url>URL to train
--name <name>Knowledge name

Also accepts the common options listed at the top of this page.

smallforce calls knowledge train-document

Train an already uploaded document using its organization-owned storage key

Usage: smallforce calls knowledge train-document [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin
--assistant-id <id>Voice assistant ID
--name <name>Knowledge name
--storage-key <key>Existing uploaded document storage key

Also accepts the common options listed at the top of this page.

smallforce calls knowledge delete

Delete knowledge through the existing deletion service

Usage: smallforce calls knowledge delete [options] <knowledgeId>

ArgumentDescription
knowledgeId—

Also accepts the common options listed at the top of this page.

smallforce calls callers

What the AI receptionist remembers about phone callers (standalone receptionists)

Examples:
  smallforce calls callers list --json
  smallforce calls callers get +15125550147 --json
  smallforce calls callers name +15125550147 --first-name Dana --last-name Lee --json
  smallforce calls callers name +15125550147 --clear --json
  smallforce calls callers forget +15125550147 --json
  smallforce calls memory add +15125550147 --content "Prefers texts over calls" --kind profile --json
  smallforce calls memory edit <memoryId> --content "Moved to 22 Oak Street in Oct 2026" --json
  smallforce calls memory delete <memoryId> --json

smallforce calls callers list

Remembered callers, most recent first

Usage: smallforce calls callers list [options]

OptionDescription
--search <text>Part of the number (digits) or of the caller’s name
--limit <number>Maximum callers (1-100)
--cursor <cursor>nextCursor from the previous page

Also accepts the common options listed at the top of this page.

smallforce calls callers get

Everything remembered about one number, with its recent call summaries

Usage: smallforce calls callers get [options] <phone>

ArgumentDescription
phone—

Also accepts the common options listed at the top of this page.

smallforce calls callers name

Set or clear a caller’s first and last name (locked: the post-call job never changes it)

Usage: smallforce calls callers name [options] <phone>

ArgumentDescription
phone—
OptionDescription
--first-name <name>First name
--last-name <name>Last name (leave out when only the first name is known)
--clearRemove the name, so the next call can fill it again

Also accepts the common options listed at the top of this page.

smallforce calls callers forget

Delete a caller and every memory about them (calls and transcripts stay)

Usage: smallforce calls callers forget [options] <phone>

ArgumentDescription
phone—

Also accepts the common options listed at the top of this page.

smallforce calls memory

Add, edit or delete one caller memory (locked: the post-call job never changes it)

smallforce calls memory add

Add a memory about a caller

Usage: smallforce calls memory add [options] <phone>

ArgumentDescription
phone—
OptionDescription
--content <text>One short sentence (at most 300 characters)
--kind <kind>profile: on the receptionist’s card at every call (how to address them, language, contact preference, relationship); fact: searched when relevant. The name is set with calls callers name (choices: “profile”, “fact”, default: “fact”)

Also accepts the common options listed at the top of this page.

smallforce calls memory edit

Change a memory’s text or kind

Usage: smallforce calls memory edit [options] <memoryId>

ArgumentDescription
memoryId—
OptionDescription
--content <text>The new sentence (at most 300 characters)
--kind <kind>profile: on the receptionist’s card at every call (how to address them, language, contact preference, relationship); fact: searched when relevant. The name is set with calls callers name (choices: “profile”, “fact”)

Also accepts the common options listed at the top of this page.

smallforce calls memory delete

Delete one memory

Usage: smallforce calls memory delete [options] <memoryId>

ArgumentDescription
memoryId—

Also accepts the common options listed at the top of this page.

smallforce calls tools

Manage the custom tools receptionists can use on calls

smallforce calls tools list

List tools and keys

Usage: smallforce calls tools list [options]

OptionDescription
--archivedInclude archived tools

Also accepts the common options listed at the top of this page.

smallforce calls tools get

Get a tool and its definition

Usage: smallforce calls tools get [options] <toolId>

ArgumentDescription
toolId—

Also accepts the common options listed at the top of this page.

smallforce calls tools create

Create a tool from JSON: { displayName, description, definition: { inputs, request, response, waitMode, … }, keyId? }

Usage: smallforce calls tools create [options]

OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls tools update

Update a tool from JSON (only the fields given change)

Usage: smallforce calls tools update [options] <toolId>

ArgumentDescription
toolId—
OptionDescription
--input <json>Full settings as a JSON object; explicit flags take precedence
--input-file <path>Read settings JSON from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls tools archive

Archive a tool (calls already running keep it)

Usage: smallforce calls tools archive [options] <toolId>

ArgumentDescription
toolId—

Also accepts the common options listed at the top of this page.

smallforce calls tools restore

Restore an archived tool

Usage: smallforce calls tools restore [options] <toolId>

ArgumentDescription
toolId—

Also accepts the common options listed at the top of this page.

smallforce calls tools test

Send a real request with the given inputs and show what the AI would hear

Usage: smallforce calls tools test [options] <toolId>

ArgumentDescription
toolId—
OptionDescription
--inputs <json>The inputs as a JSON object, e.g. ’{“order_number”:“1042”}’
--caller-phone <e164>Pretend caller phone, e.g. +15551234567
--caller-confirmedTreat the caller’s number as confirmed by their phone company
--assistant <assistantId>Fill receptionist name and time zone from this receptionist

Also accepts the common options listed at the top of this page.

smallforce calls tools import-curl

Turn a curl command into a draft tool (nothing is saved)

Usage: smallforce calls tools import-curl [options]

OptionDescription
--command <curl>The curl command
--command-file <path>Read the curl command from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls tools runs

Show a tool’s recent runs

Usage: smallforce calls tools runs [options] <toolId>

ArgumentDescription
toolId—
OptionDescription
--days <number>How far back (1-90, default 7)
--limit <number>Maximum runs (1-100)
--source <source>Only runs from (choices: “call”, “test_call”, “test_button”)
--outcome <outcome>Only runs that ended this way (ok, timeout, http_error, key_rejected, …)

Also accepts the common options listed at the top of this page.

smallforce calls tools on

Turn a tool on for a receptionist (from its next call)

Usage: smallforce calls tools on [options] <assistantId> <toolId>

ArgumentDescription
assistantId—
toolId—

Also accepts the common options listed at the top of this page.

smallforce calls tools off

Turn a tool off for a receptionist (from its next call)

Usage: smallforce calls tools off [options] <assistantId> <toolId>

ArgumentDescription
assistantId—
toolId—

Also accepts the common options listed at the top of this page.

smallforce calls tools for

List every tool with whether it’s on for a receptionist

Usage: smallforce calls tools for [options] <assistantId>

ArgumentDescription
assistantId—

Also accepts the common options listed at the top of this page.

smallforce calls tools signing-secret

Show or rotate the secret every tool request is signed with

smallforce calls tools signing-secret show

Show the signing secret

Usage: smallforce calls tools signing-secret show [options]

Also accepts the common options listed at the top of this page.

smallforce calls tools signing-secret rotate

Replace the signing secret now (old signatures stop verifying)

Usage: smallforce calls tools signing-secret rotate [options]

Also accepts the common options listed at the top of this page.

smallforce calls tool-keys

Manage the keys custom tools send (each only to its own website)

smallforce calls tool-keys create

Save a key for tools to send to one website

Usage: smallforce calls tool-keys create [options]

OptionDescription
--name <name>Name, e.g. “GHL token”
--kind <kind>How it’s sent (choices: “bearer”, “header”, “basic”)
--host <host>The only website it’s sent to, e.g. api.example.com
--header <name>Header name for —kind header, e.g. X-API-Key
--secret-file <path>Read the token or key from a file, or - for stdin (never pass secrets as flags)
--username <username>Username for —kind basic
--password-file <path>Read the password for —kind basic from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls tool-keys update

Rename a key, replace its secret, or move it to another website

Usage: smallforce calls tool-keys update [options] <keyId>

ArgumentDescription
keyId—
OptionDescription
--name <name>New name
--host <host>New website (needs the secret again)
--header <name>New header name (API-key keys)
--secret-file <path>Read the new token or key from a file, or - for stdin

Also accepts the common options listed at the top of this page.

smallforce calls tool-keys delete

Delete a key no tool uses

Usage: smallforce calls tool-keys delete [options] <keyId>

ArgumentDescription
keyId—

Also accepts the common options listed at the top of this page.