> For the complete documentation index, see [llms.txt](https://docs.amigo.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.amigo.ai/developer-guide/classic-api/sdks/sdk-installation.md).

# Installation

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

{% hint style="warning" %}
**Classic API only.** These SDKs are for the Classic API. Platform API developers should use the [Platform SDK](/developer-guide/platform-api/platform-sdk.md) for TypeScript or direct HTTP while additional first-party Platform SDKs are added.
{% endhint %}

{% tabs %}
{% tab title="Python" %}

### 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:

```bash
pip install amigo_sdk
```

### Add to requirements.txt

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

```txt
amigo_sdk==1.3.1
```

Then install dependencies:

```bash
pip install -r requirements.txt
```

### Virtual Environment (Recommended)

We recommend using a virtual environment to avoid dependency conflicts:

```bash
# 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:

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

{% endtab %}

{% tab title="TypeScript" %}

### 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:

```bash
npm install @amigo-ai/sdk@1.0.0
```

{% hint style="warning" %}
**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.
{% endhint %}

### 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:

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

### Verify Installation

Verify the installation by importing the SDK:

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

{% endtab %}
{% endtabs %}

## Next Step: Configure Credentials

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

{% content-ref url="/pages/12J3NlWYY4gpop7b7ad6" %}
[Configuration](/developer-guide/classic-api/sdks/sdk-configuration.md)
{% endcontent-ref %}

Then create your first conversation with the [Hello World Example](/developer-guide/classic-api/sdks/sdk-hello-world.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.amigo.ai/developer-guide/classic-api/sdks/sdk-installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.