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

# Introduction

> Get started with the Lingopal Cookbook - a Python client for connecting to the Lingopal transcription WebSocket service.

# 🚀 Lingopal Cookbook

This repository contains a simple Python client that connects to the Lingopal transcription WebSocket service using your stream ID and API key.

📌 **GitHub Repo:** [https://github.com/lingopal-ai/lingopal-reference](https://github.com/lingopal-ai/lingopal-reference)

## 📦 Installation

### ✅ Make sure Python 3.8+ is installed

Check your Python version:

```bash theme={null}
python3 --version
```

If you don't have Python, download it from [https://www.python.org/downloads/](https://www.python.org/downloads/).

### 📁 Set Up and Activate a Virtual Environment

In the root of this repo:

```bash theme={null}
python3 -m venv env
source env/bin/activate  # On Windows: env\Scripts\activate
```

### ⬇️ Install the dependencies

Install the package in editable/development mode:

```bash theme={null}
pip install -e .
```

## What's Next?

After installation, you can:

* [Start a stream via API](/api-reference/endpoint/start-stream-via-api)
* [Connect to the WebSocket client](/api-reference/endpoint/lingopal-websocket-client)
* Explore the examples in the `examples/` directory
* Check out the full API documentation

## Getting Help

* Visit our [GitHub repository](https://github.com/lingopal-ai/lingopal-reference) for the latest code and issues