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

The official .NET SDK repository includes runnable sample projects that mirror the flows documented in this guide.

## GitHub repository

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

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

Sample projects consume the published NuGet package (`VZaps.SDK`). The console sample runs numbered flows from `01` through `11`.

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

## What's included

| Project                     | Topic                            |
| --------------------------- | -------------------------------- |
| `VZaps.Examples.Console`    | Numbered flows `01` through `11` |
| `VZaps.Examples.Worker`     | Realtime WebSocket worker        |
| `VZaps.Examples.AspNetCore` | ASP.NET Core integration sample  |

Console flows:

| Argument | Topic                            |
| -------- | -------------------------------- |
| `01`     | Auth and instance listing        |
| `02`     | Create instance                  |
| `03`     | Billing subscription             |
| `04`     | Session and pairing              |
| `05`     | Webhook configuration            |
| `06`     | Realtime subscription            |
| `07`     | Send text message                |
| `08`     | Media and interactive messages   |
| `09`     | Poll, reaction, and chat actions |
| `10`     | Queues                           |
| `11`     | TypeBot and Chatwoot             |

## Option A — console sample only (recommended)

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

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

```bash theme={null}
npx --yes degit VZaps/vzaps-sdk-dotnet/examples/VZaps.Examples.Console vzaps-dotnet-console
cd vzaps-dotnet-console
```

2. Set credentials and run one flow:

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

## Option B — sparse checkout

```bash theme={null}
git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-dotnet.git
cd vzaps-sdk-dotnet
git sparse-checkout set examples/VZaps.Examples.Console
cd examples/VZaps.Examples.Console
dotnet run -- 07
```

## Option C — full repository clone

```bash theme={null}
git clone https://github.com/VZaps/vzaps-sdk-dotnet.git
cd vzaps-sdk-dotnet/examples/VZaps.Examples.Console
dotnet run -- 07
```

When developing the SDK locally, replace the NuGet reference with a project reference to `src/VZaps.SDK/VZaps.SDK.csproj`.

## Next steps

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