Skip to main content

​
Install the SDK

Install Ziet using pip: 
pip install ziet
Recommended: Use a virtual environment to isolate dependencies.
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install ziet

​
Install the CLI

The Ziet CLI is included with the SDK. Verify installation: 
ziet --version
Expected output: 
ziet version 0.1.0

​
Authentication

​
Get Your API Key

  1. Sign up at dashboard.ziet.ai
  2. Navigate to Developer → API Keys
  3. Click Create API Key
  4. Copy your key (starts with ziet_)

​
Set Your API Key

export ZIET_API_KEY="ziet_your_api_key_here"
Never commit your API key to version control. Add .env to your .gitignore.

​
Verify Installation

Create a test file hello.py: 
from ziet import Action

@Action(description="Say hello")
def hello(name: str) -> str:
    return f"Hello, {name}!"

if __name__ == "__main__":
    result = hello("World")
    print(result)
Run it: 
python hello.py
Expected output: 
[INFO] Action hello started
Hello, World!
[INFO] Action hello completed in 0.00s

​
Initialize a Project

Create a new Ziet project: 
ziet init my-agent-project
cd my-agent-project
This creates a boilerplate structure: 
my-agent-project/
├── agent.py          # Main agent definition
├── actions.py        # Action functions
├── requirements.txt  # Python dependencies
├── .env             # Environment variables (git-ignored)
├── .gitignore
└── ziet.yaml        # Project configuration

​
Project Configuration

Edit ziet.yaml to configure your project: 
name: my-agent-project
runtime: python3.11
environment: production

# Environment variables (synced from dashboard)
env:
  - OPENAI_API_KEY
  - STRIPE_API_KEY

# Deployment settings
deploy:
  region: us-east-1
  timeout: 300
  memory: 512

​
System Requirements

Required: Python 3.9 or higherCheck your version:
python --version
Ziet is tested on Python 3.9, 3.10, 3.11, and 3.12.
Ziet has minimal dependencies and installs everything needed:
  • No external databases required
  • No Redis, Celery, or message queues
  • No Docker (unless you want to use it)
The SDK is lightweight (~5MB) and installs in seconds.
Ziet works on:
  • macOS: 10.15 (Catalina) or later
  • Linux: Ubuntu 20.04+, Debian 10+, CentOS 8+
  • Windows: Windows 10/11 (via WSL2 recommended)

​
Troubleshooting

Solution: Ensure you’re using the correct Python environment.
which python  # Check which Python is active
pip list | grep ziet  # Verify ziet is installed
If needed, reinstall:
pip uninstall ziet
pip install ziet
Solution: Verify your API key is set correctly.
echo $ZIET_API_KEY  # Should print your key
If empty, set it:
export ZIET_API_KEY="ziet_your_key_here"
Solution: The CLI wasn’t added to PATH.
# Find where pip installed ziet
pip show ziet

# Add to PATH (add to ~/.bashrc or ~/.zshrc)
export PATH="$PATH:$(python -m site --user-base)/bin"

​
Next Steps

Quickstart

Build your first agent in 5 minutes

Actions

Learn about serverless actions

Agents

Build intelligent agents