GitHub Repository
View source code, examples, and documentation
Requirements
- Python 3.11 or later. Python 3.10 is the minimum the client installs on, but it reached end of life in October 2026.
- 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 Set your credentials in the activated shell (or persist them in If you’re using the Archetype AI free trial, use the following instead:
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:~/.zshrc):pip install archetypeai.
For more on credentials, see Environment Variables.
Alternative: Conda
Alternative: Conda
If you prefer Anaconda or Miniconda to manage Python environments, create and activate an environment and install the client inside it:
Verify Installation
Test that the client is correctly installed by running (inside your activated environment):What’s Included
The Python client includes:- API Client: Core client for interacting with the Archetype platform
- Examples: Sample scripts demonstrating common use cases
Build and Run a Package
Requires version 2.0.1 or later of the Archetype platform.
client.agents.packages, deploy it
with client.agents.deployments, and run it with client.agents.sessions. Only a package in a
project can be deployed, so start by copying a blueprint into a project:
- Client version 26.10.30.0 removes
client.agents.bundlesandclient.agents.instances. Code that uses them must move to deployments and sessions. client.agents.deploymentsalso provideslist,get,stop, anddelete.wait_until_readyreturns once the deployment isready,stopped, orfailed.client.agents.sessionsalso provideslist,get,get_events,cancel, anddelete.- A package that has deployments cannot be deleted. Stop and delete its deployments first.
Upgrade Python Client
-
To show the currently installed version of the python client, please use
-
To upgrade to the latest version of the python client, please use
Please note the minimum requirements here.