> ## Documentation Index
> Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Python

The official Python client for the Archetype platform provides a simple interface to interact with the Archetype API.

<Card title="GitHub Repository" icon="github" href="https://github.com/archetypeai/python-client">
  View source code, examples, and documentation
</Card>

## Quick Install

```bash theme={"system"}
python -m pip install archetypeai
```

## Requirements

* Python 3.10 or later
* An Archetype API key (see [Libraries](/libraries) for setup instructions)

## Verify Installation

Test that the client is correctly installed by running:

```bash theme={"system"}
python -c "from archetypeai.api_client import ArchetypeAI; print(f'Version: {ArchetypeAI.get_version()}')"
```

If successful, you should see a version number printed:

```bash theme={"system"}
Version: 25.x.x
```

## Environment Setup

We recommend using Anaconda or Miniconda to manage your Python environment.

<Accordion title="Install Anaconda on Linux">
  Download and install [Anaconda or Miniconda](https://www.anaconda.com/download/success):

  ```bash theme={"system"}
  wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
  bash Anaconda3-2022.05-Linux-x86_64.sh
  source ~/.bashrc
  ```

  Create and activate an atai environment:

  ```bash theme={"system"}
  conda create -n atai python=3.10
  conda activate atai
  ```
</Accordion>

Alternatively, you can use your system Python if you have version 3.10 or later installed.

## What's Included

The Python client includes:

* **API Client**: Core client for interacting with the Archetype platform
* [**Examples**](https://github.com/archetypeai/python-client/tree/main/examples): Sample scripts demonstrating common use cases

## Upgrade Python Client

* To show the latest version of the python client, please use

  ```bash theme={"system"}
  pip show archetypeai
  ```
* To upgrade the latest version of the python client, please use

  ```bash theme={"system"}
  pip install --upgrade archetypeai
  ```

<Note>
  Please note the minimum requirements [here](https://docs.archetypeai.app/libraries/python#requirements)
</Note>