Installation

Install the Amigo SDK in Python (pip) or TypeScript (npm) with environment setup instructions.

This guide covers installing the Amigo SDK in your Python or TypeScript/JavaScript project.

Classic API only. These SDKs are for the Classic API. Platform API developers should use the Platform SDK for TypeScript or direct HTTP while additional first-party Platform SDKs are added.

Requirements

Python 3.11 or higher
pip (Python package manager)

Install from PyPI

Install the latest version of the Python SDK (currently 1.3.1) using pip:

pip install amigo_sdk

Add to requirements.txt

For reproducible builds, pin the SDK version in your requirements.txt file:

amigo_sdk==1.3.1

Then install dependencies:

pip install -r requirements.txt

Virtual Environment (Recommended)

We recommend using a virtual environment to avoid dependency conflicts:

# Create virtual environment
python -m venv amigo-env

# Activate virtual environment
# On macOS/Linux:
source amigo-env/bin/activate
# On Windows:
amigo-env\Scripts\activate

# Install SDK
pip install amigo_sdk

Verify Installation

Verify the installation by importing the SDK:

from amigo_sdk import AmigoClient
print("Amigo Python SDK installed successfully!")

Requirements

Node.js 18 or higher
npm or yarn package manager

Install from npm

Install the current version of the TypeScript SDK (1.0.0) with an explicit version:

npm install @amigo-ai/sdk@1.0.0

Pin the version. The current release of this SDK is 1.0.0. The 1.1.x versions on npm are deprecated and are not releases of this SDK, so a bare npm install @amigo-ai/sdk may resolve to a deprecated version. Install @amigo-ai/sdk@1.0.0 explicitly.

Add to package.json

npm install writes the dependency to your package.json automatically. Only the current SDK release is guaranteed to match the current API.

TypeScript Configuration

If you're using TypeScript, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

Verify Installation

Verify the installation by importing the SDK:

import { AmigoClient } from '@amigo-ai/sdk'
console.log('Amigo TypeScript SDK installed successfully!')

Next Step: Configure Credentials

With the SDK installed, configure your client with API credentials, environment variables, and the correct regional base URL.

Configuration

Then create your first conversation with the Hello World Example.

PreviousClassic SDKs NextConfiguration

Last updated 17 hours ago

Was this helpful?