CLI - Assistable.ai Docs

The CLI (assistableai) gives you every v3 operation from your terminal or scripts, grouped by resource. Commands are generated from the OpenAPI spec.

npm install -g @assistableai/cli
# or run without installing: npx @assistableai/cli --help

Authenticate

assistableai login --api-key ask_live_… --subaccount <subaccount-id>

Credentials are stored at ~/.assistableai/config.json (mode 0600). Resolution precedence for any command: explicit flag → environment (ASSISTABLE_API_KEY, ASSISTABLE_SUBACCOUNT_ID, ASSISTABLE_BASE_URL) → stored config.

assistableai whoami     # show the active credentials (key masked)
assistableai logout     # delete stored credentials

Use it

Commands are grouped by resource topic; add --help at any level:

assistableai --help                  # list topics
assistableai assistants --help       # commands in a topic
assistableai assistants list --help  # flags + args for one command

# Read (table by default; --json for scripting)
assistableai assistants list --limit 10
assistableai assistants get <assistant-id> --json

# Target a subaccount for one call
assistableai contacts list -s <subaccount-id>

# Write operations take a JSON body via -d / --data (or --data-file, '-' = stdin)
assistableai contacts create -d '{"first_name":"Ada","email":"[email protected]"}'
echo '{"name":"Support bot"}' | assistableai assistants create --data-file -

Global flags

Flag	Description
`--json`	Print the raw `{ data, error, request_id }` response
`-s, --subaccount <id>`	Target subaccount (`X-Subaccount-Id`) for this call
`--api-key <key>`	Override the stored/env key for this call
`--base-url <url>`	Override the API base URL
`-d, --data <json>`	JSON request body for write operations
`--data-file <path>`	Read the JSON body from a file (`-` for stdin)

On an API error the message (with request_id) is written to stderr and the process exits non-zero, so it composes cleanly in shell pipelines and CI.