Skip to main content

SmallWebSocket Prebuilt

A simple, ready-to-use client for testing the WebSocketTransport with Pipecat.

This prebuilt client provides basic WebSocket voice AI functionality and serves as a lightweight tool to quickly verify transport behavior without needing a custom implementation.

Ideal for development, debugging, and quick prototyping.


📦 Installation & Usage

If you just want to use the prebuilt WebSocket client in your own Python project:

✅ Install from PyPI

pip install small-websocket-prebuilt

🧰 Example Usage

from fastapi import FastAPI
from fastapi.responses import RedirectResponse
from small_websocket_prebuilt.frontend import SmallWebSocketPrebuiltUI

app = FastAPI()

# Mount the frontend at /prebuilt
app.mount("/prebuilt", SmallWebSocketPrebuiltUI)

@app.get("/", include_in_schema=False)
async def root_redirect():
    return RedirectResponse(url="/prebuilt/")

⌨ Development Quick Start

If you want to work on the prebuilt client itself or use it locally in development:

📋 Prerequisites

  • Node.js (for building the client)
  • uv (recommended for Python dependency management)

🔗 WebSocket Transport

The client uses @pipecat-ai/websocket-transport to connect to your Pipecat bot.

You can connect either:

  • Directly using a WebSocket URL: ws://localhost:7860/ws
  • Via endpoint: provide an HTTP URL that returns the WebSocket connection info

Metadata

Release files for small-websocket-prebuilt 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for small-websocket-prebuilt 0.3.0
File Size Uploaded Provenance Actions
small_websocket_prebuilt-0.3.0.tar.gz 486.0 kB With provenance Details for small_websocket_prebuilt-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for small-websocket-prebuilt 0.3.0
File Interpreter ABI Platform Actions
small_websocket_prebuilt-0.3.0-py3-none-any.whl Python 3 none any Details for small_websocket_prebuilt-0.3.0-py3-none-any.whl

Total release size: 972.6 kB

Release files / small_websocket_prebuilt-0.3.0.tar.gz

Download URL small_websocket_prebuilt-0.3.0.tar.gz
Size 486.0 kB
Tags Source
SHA-256 checksum
How to use checksums
092656802878c383dbabafb0fe215678f3c836302419a6d11c34df1c49fbfbc6
BLAKE2b-256 checksum
How to use checksums
c38d42b0bcdaee59fbd7387245f221b326c321b69f9d7b5eb70df5f0a1c71df9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / small_websocket_prebuilt-0.3.0-py3-none-any.whl

Download URL small_websocket_prebuilt-0.3.0-py3-none-any.whl
Size 486.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e748a2aaa4653e4a0f162f9ff427034518e0590a900f26f03c7feddd048a74c
BLAKE2b-256 checksum
How to use checksums
0457baa538723e8a4e4a5b2902e7528864bf849ce1f89f4791a0b8e00548d0ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Security for small-websocket-prebuilt 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for small_websocket_prebuilt-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page