Python

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

GitHub Repository

View source code, examples, and documentation

Requirements

Python 3.10 or later
An Archetype API key (see Libraries for setup instructions)

Install

Create a virtual environment, install the client, and set your credentials for your operating system:

macOS
Debian / Ubuntu
Red Hat / Amazon Linux
Windows

macOS ships with python3. Recent Homebrew and system Pythons block system-wide installs (PEP 668), so create a virtual environment first — a bare pip install fails with externally-managed-environment:

python3 -m venv venv
source venv/bin/activate

pip install archetypeai

Set your credentials in the activated shell (or persist them in ~/.zshrc):

export ATAI_API_KEY="your_secret_key"
export ATAI_API_ENDPOINT="https://api.u1.archetypeai.app/v0.5"

Debian and Ubuntu need the venv module installed separately, and their Pythons block system-wide installs (PEP 668), so create a virtual environment first:

sudo apt update && sudo apt install -y python3-venv

python3 -m venv venv
source venv/bin/activate

pip install archetypeai

Set your credentials in the activated shell (or persist them in ~/.bashrc):

export ATAI_API_KEY="your_secret_key"
export ATAI_API_ENDPOINT="https://api.u1.archetypeai.app/v0.5"

Check your Python version first — the client needs 3.10 or later:

python3 --version

If it shows 3.10 or later, create the virtual environment with python3 directly:

python3 -m venv venv
source venv/bin/activate

pip install archetypeai

If it’s older than 3.10, install a newer interpreter first and use it instead — the package name varies by release, so check what’s available (dnf list 'python3.*'):

sudo dnf install -y python3.11 python3.11-pip

python3.11 -m venv venv
source venv/bin/activate

pip install archetypeai

Set your credentials in the activated shell (or persist them in ~/.bashrc):

export ATAI_API_KEY="your_secret_key"
export ATAI_API_ENDPOINT="https://api.u1.archetypeai.app/v0.5"

Install Python 3.10+ from python.org (check Add python.exe to PATH during setup).If you’re in a console-only session (SSM/SSH), install silently from PowerShell instead (adjust to the latest Python release):

Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.12.10/python-3.12.10-amd64.exe" -OutFile "$env:TEMP\python-installer.exe"
& "$env:TEMP\python-installer.exe" /quiet InstallAllUsers=1 PrependPath=1 Include_launcher=1

Important either way: open a new PowerShell window afterward — PATH changes don’t reach the existing session. Then:

py -m venv venv
.\venv\Scripts\Activate.ps1

pip install archetypeai

If activation is blocked by the execution policy, allow local scripts first:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Set your credentials for the current session (use setx to persist them for new sessions):

$env:ATAI_API_KEY = "your_secret_key"
$env:ATAI_API_ENDPOINT = "https://api.u1.archetypeai.app/v0.5"

On other Linux distributions, the same pattern applies: ensure Python 3.10+ is installed, create and activate a virtual environment, then pip install archetypeai. For more on credentials, see Environment Variables.

Alternative: Conda

If you prefer Anaconda or Miniconda to manage Python environments, create and activate an environment and install the client inside it:

conda create -n atai python=3.10
conda activate atai
pip install archetypeai

Verify Installation

Test that the client is correctly installed by running (inside your activated environment):

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

If successful, you should see a version number printed:

Version: 26.04.30.0

What’s Included

The Python client includes:

API Client: Core client for interacting with the Archetype platform
Examples: Sample scripts demonstrating common use cases

Upgrade Python Client

To show the currently installed version of the python client, please use
pip show archetypeai
To upgrade to the latest version of the python client, please use
pip install --upgrade archetypeai

Please note the minimum requirements here.

Introduction

Core Concepts

Developer Console

Libraries

Examples

Help & Support

Archive

GitHub Repository

Requirements

Install

Verify Installation

What’s Included

Upgrade Python Client

GitHub Repository

​Requirements

​Install

​Verify Installation

​What’s Included

​Upgrade Python Client

Requirements

Install

Verify Installation

What’s Included

Upgrade Python Client