Skip to main content

Installation

Prerequisites​

  • A ToothFairyAI API key and workspace ID. Create an API key in the platform under Settings → API Keys; your workspace ID is shown under Settings → General.
  • A supported runtime (see below).

Node.js​

Requires Node.js >= 14.0.0.

SDK — for application code:

@toothfairyai/sdk@latest… 
npm install @toothfairyai/sdk
# or
yarn add @toothfairyai/sdk

CLI — install globally for terminal use:

@toothfairyai/cli@latest… 
npm install -g @toothfairyai/cli

The CLI exposes two binaries: toothfairy and the shorter alias tf.

toothfairy --version
tf --help

Python​

The SDK requires Python >= 3.8; the CLI requires Python >= 3.7.

SDK — for application code:

toothfairyai@latest… 
pip install toothfairyai

CLI — the command-line tool:

toothfairy-cli@latest… 
pip install toothfairy-cli
toothfairy --version
toothfairy --help
Virtual environments

For the Python SDK, install into a virtual environment (python -m venv .venv && source .venv/bin/activate) to avoid conflicts with other projects.

Verifying credentials​

Both SDKs validate credentials when you construct the client and will raise MissingApiKeyError / MISSING_API_KEY if either value is absent. To confirm connectivity end-to-end, call the client's connection probe:

// Node.js
const ok = await client.testConnection();
# Python
ok = client.test_connection()

See Authentication & routing for full client configuration.