Installation

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

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

Set Your API Key

export ZIET_API_KEY="ziet_your_api_key_here"

# .env
ZIET_API_KEY=ziet_your_api_key_here

import os
os.environ["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

Python Version

Required: Python 3.9 or higherCheck your version:

python --version

Ziet is tested on Python 3.9, 3.10, 3.11, and 3.12.

Dependencies

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.

Operating Systems

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

ImportError: No module named 'ziet'

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

Authentication Error: Invalid API Key

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"

ziet: command not found

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

Getting Started

Agentic

Application

Integrations

Deployment

Installation

Install the SDK

Install the CLI

Authentication

Get Your API Key

Set Your API Key

Verify Installation

Initialize a Project

Project Configuration

System Requirements

Troubleshooting

Next Steps

Quickstart

Actions

Agents

​Install the SDK

​Install the CLI

​Authentication

​Get Your API Key

​Set Your API Key

​Verify Installation

​Initialize a Project

​Project Configuration

​System Requirements

​Troubleshooting

​Next Steps

Quickstart

Actions

Agents

Install the SDK

Install the CLI

Authentication

Get Your API Key

Set Your API Key

Verify Installation

Initialize a Project

Project Configuration

System Requirements

Troubleshooting

Next Steps