> ## 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 TypeScript SDK on GitHub

The official TypeScript SDK repository includes runnable `.ts` files that mirror the flows documented in this guide.

## GitHub repository

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

**[github.com/VZaps/vzaps-sdk-typescript](https://github.com/VZaps/vzaps-sdk-typescript)**

The folder includes a small `package.json` that installs the published npm package (`@vzaps/sdk`) and `tsx`.

See [`examples/README.md`](https://github.com/VZaps/vzaps-sdk-typescript/blob/main/examples/README.md) in the repository for the full file list.

## What's included

| File                                        | Topic                                |
| ------------------------------------------- | ------------------------------------ |
| `01-auth-and-list-instances.ts`             | Auth and instance listing            |
| `02-create-instance.ts`                     | Create instance                      |
| `03-instance-subscription.ts`               | Billing subscription                 |
| `04-session-and-pairing.ts`                 | Session status, QR, and pairing code |
| `05-configure-webhook.ts`                   | Webhook configuration                |
| `06-realtime-subscribe.ts`                  | Realtime WebSocket subscription      |
| `07-send-text-message.ts`                   | Send text message                    |
| `08-send-media-and-interactive.ts`          | Media, buttons, and list             |
| `09-send-poll-reaction-and-chat-actions.ts` | Poll, reaction, and chat actions     |
| `10-queues.ts`                              | Message and operation queues         |
| `11-typebot-and-chatwoot.ts`                | 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-typescript/tree/main/examples) folder using **Download ZIP** on GitHub, or run:

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

2. Install dependencies, edit constants in the file you want to run, and execute:

```bash theme={null}
npm install
npx tsx 07-send-text-message.ts
```

## Option B — sparse checkout

```bash theme={null}
git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript
git sparse-checkout set examples
cd examples
npm install
npx tsx 07-send-text-message.ts
```

## Option C — full repository clone

```bash theme={null}
git clone https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript/examples
npm install
npx tsx 07-send-text-message.ts
```

When developing the SDK itself, build and link the local package first. See the repository README for contributor setup.

## Next steps

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