Skip to main content
The official Python SDK repository includes runnable scripts that mirror the flows documented in this guide.

​
GitHub repository

All examples live in the examples/ folder: github.com/VZaps/vzaps-sdk-python The folder includes requirements.txt for the published PyPI package (vzaps) and shared credential loading in _env.py. See examples/README.md in the repository for the full file list.

​
What’s included

FileTopic
01_auth_and_list_instances.pyAuth and instance listing
02_create_instance.pyCreate instance
03_instance_subscription.pyBilling subscription
04_session_and_pairing.pySession status, QR, and pairing code
05_configure_webhook.pyWebhook configuration
06_realtime_subscribe.pyRealtime WebSocket subscription
07_send_text_message.pySend text message
08_send_media_and_interactive.pyMedia, buttons, and list
09_send_poll_reaction_and_chat_actions.pyPoll, reaction, and chat actions
10_queues.pyMessage and operation queues
11_typebot_and_chatwoot.pyTypeBot and Chatwoot
You do not need to clone the full SDK repository.
  1. Download only the examples/ folder using Download ZIP on GitHub, or run:
npx --yes degit VZaps/vzaps-sdk-python/examples vzaps-python-examples
cd vzaps-python-examples
  1. Install dependencies, set environment variables, and run:
pip install -r requirements.txt
export VZAPS_CLIENT_TOKEN=your-client-token
export VZAPS_CLIENT_SECRET=your-client-secret
export VZAPS_INSTANCE_ID=VZ...
export VZAPS_INSTANCE_TOKEN=your-instance-token
python 07_send_text_message.py

​
Option B — sparse checkout

git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-python.git
cd vzaps-sdk-python
git sparse-checkout set examples
cd examples
pip install -r requirements.txt
python 07_send_text_message.py

​
Option C — full repository clone

git clone https://github.com/VZaps/vzaps-sdk-python.git
cd vzaps-sdk-python
pip install -e .
python examples/07_send_text_message.py
Use pip install -e . when you are developing the SDK locally.

​
Next steps