> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Examples

> Runnable examples for the VZaps Python SDK on GitHub

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

## GitHub repository

All examples live in the [`examples/`](https://github.com/VZaps/vzaps-sdk-python/tree/main/examples) folder:

**[github.com/VZaps/vzaps-sdk-python](https://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`](https://github.com/VZaps/vzaps-sdk-python/blob/main/examples/README.md) in the repository for the full file list.

## What's included

| File                                        | Topic                                |
| ------------------------------------------- | ------------------------------------ |
| `01_auth_and_list_instances.py`             | Auth and instance listing            |
| `02_create_instance.py`                     | Create instance                      |
| `03_instance_subscription.py`               | Billing subscription                 |
| `04_session_and_pairing.py`                 | Session status, QR, and pairing code |
| `05_configure_webhook.py`                   | Webhook configuration                |
| `06_realtime_subscribe.py`                  | Realtime WebSocket subscription      |
| `07_send_text_message.py`                   | Send text message                    |
| `08_send_media_and_interactive.py`          | Media, buttons, and list             |
| `09_send_poll_reaction_and_chat_actions.py` | Poll, reaction, and chat actions     |
| `10_queues.py`                              | Message and operation queues         |
| `11_typebot_and_chatwoot.py`                | TypeBot and Chatwoot                 |

## Option A — examples folder only (recommended)

You do **not** need to clone the full SDK repository.

1. Download only the [`examples/`](https://github.com/VZaps/vzaps-sdk-python/tree/main/examples) folder using **Download ZIP** on GitHub, or run:

```bash theme={null}
npx --yes degit VZaps/vzaps-sdk-python/examples vzaps-python-examples
cd vzaps-python-examples
```

2. Install dependencies, set environment variables, and run:

```bash theme={null}
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

```bash theme={null}
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

```bash theme={null}
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

* Follow the [Starter Guide](/en/sdk/python/starter-guide) for a guided walkthrough.
* See [Messages](/en/sdk/python/messages) for every send method.