Skip to main content

Getting Started

Learn how to install and configure the Vaiz Python SDK.

Prerequisites​

  • Python 3.8 or higher
  • pip package manager

Installation​

Install the SDK using pip:

pip install vaiz-sdk

Environment Setup​

Environment Variables​

Create a .env file in your project root:

VAIZ_API_KEY=your_api_key
VAIZ_SPACE_ID=your_space_id
Where to get API key?

You can get your API key from your profile settings on the Vaiz App.

Loading Variables​

from dotenv import load_dotenv
import os

load_dotenv()

api_key = os.getenv("VAIZ_API_KEY")
space_id = os.getenv("VAIZ_SPACE_ID")

Creating a Client​

Production Environment​

from vaiz import VaizClient

client = VaizClient(
    api_key="your_api_key",
    space_id="your_space_id"
)

Next Steps​

Now you know the basics of working with Vaiz SDK! Here's what to explore next: