Skip to main content
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

​
Quick Install

python -m pip install archetypeai

​
Requirements

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

​
Verify Installation

Test that the client is correctly installed by running: 
python -c "from archetypeai.api_client import ArchetypeAI; print(f'Version: {ArchetypeAI.get_version()}')"
If successful, you should see a version number printed: 
Version: 25.x.x

​
Environment Setup

We recommend using Anaconda or Miniconda to manage your Python environment.
Download and install Anaconda or Miniconda:
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:
conda create -n atai python=3.10
conda activate atai
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: Sample scripts demonstrating common use cases

​
Upgrade Python Client

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