deepflow-voicespeed-cli

Command line client for VoiceSpeed OpenAPI.

Install

pip install deepflow-voicespeed-cli

Configure

export VOICESPEED_BASE_URL=http://localhost:5002
export VOICESPEED_API_KEY=YOUR_API_KEY

Both values can also be passed with --base-url and --api-key.

Learn the system from the CLI

voicespeed guide            # concepts, typical flow, scope per command, error codes
voicespeed <resource> --help
voicespeed models list      # model ids for --voice-llm / --text-llm

voicespeed guide works offline and needs no API key.

Usage

voicespeed agents list --status enabled
voicespeed agents create --name "Support" --description "Demo agent"
voicespeed agents update 1 --name "Support Pro"
voicespeed agents disable 1
voicespeed agents enable 1
voicespeed agents get 1
voicespeed agents search-settings 1
voicespeed models list
voicespeed agents basic-settings 1
voicespeed agents update-basic-settings 1 --prompt "You are a support assistant."
voicespeed agents update-basic-settings 1 --prompt-file prompt.txt \
  --opening-mode fixed_greeting --greeting "Hello, how can I help?"
voicespeed agents performance-settings 1
voicespeed agents update-performance-settings 1 --endpoint-silence-ms 800 \
  --turn-detection-enabled --barge-sensitivity balanced
voicespeed agents update-performance-settings 1 --clear endpoint-silence-ms
voicespeed agents update-performance-settings 1 --clear-all
voicespeed conversation run 1 --message "Hello" --mode text2text \
  --variables '{"customer_name":"Ada"}'
voicespeed calls preset-variables 1 call_42 \
  --variables '{"customer_name":"Ada","order_no":"A1024"}'
voicespeed realtime-sessions create 1 --external-id call_42 \
  --variables '{"customer_name":"Ada"}'
voicespeed sessions list 1 --session-id call_42
voicespeed sessions get 1 call_42

agents update-basic-settings changes only the fields passed on the command line. Use --prompt-file, --runtime-context-file, or --greeting-file for long text.

agents update-performance-settings (dialog rhythm) also changes only the passed knobs. --clear FIELD (repeatable) or --clear-all restores knobs to the FlowKit default. Reading with performance-settings works with a chat or config key; updating needs config.

--variables is a JSON object of text values. It is optional on conversation run and realtime-sessions create. calls preset-variables stores values for a FlowKit call before it starts; the call id is the same value later sent as session_id.

All successful commands print formatted JSON.