docs

README

github.com/Voxray-AI/Voxray Documentation

Documentation for the github.com/Voxray-AI/Voxray real-time voice pipeline server.

---

Reading order

1. ARCHITECTURE.md — Start here for the component view (CLI → Server → Transport → Pipeline → Processors), data flow, and file layout.
2. SYSTEM_ARCHITECTURE.md — System view, entry points, runner modes, and deployment diagram. Or CONNECTIVITY.md if you need “what can connect” (WebSocket, WebRTC, telephony) first.
3. As needed: DEPLOYMENT.md (production), EXTENSIONS.md (IVR, Voicemail), FRAMEWORKS.md (external chain, RTVI).
4. WEBSOCKET_SERVICES.md — For implementers: WebSocket service base (reconnection, backoff).
5. skills/README.md — Contributor onboarding: skills map and role-based reading order.

---

Documentation index

Document	Description
ARCHITECTURE.md	Component view: CLI → Server → Transport → Pipeline → Processors; concurrency and performance (§5.2); Mermaid diagrams; data flow; file layout
SYSTEM_ARCHITECTURE.md	System view: C4 context, entry points table, runner modes, deployment view, design decisions
CONNECTIVITY.md	What can connect (WebSocket, WebRTC, telephony), wire formats, deployment choices
DEPLOYMENT.md	Production: env vars, health/ready, TLS, performance tuning, scaling, security, Docker
EXTENSIONS.md	IVR and Voicemail extensions (usage, pipeline order, frames, hooks)
FRAMEWORKS.md	External chain (Langchain/Strands) and RTVI protocol
WEBSOCKET_SERVICES.md	WebSocket service base: reconnection, backoff (for implementers)
skills/README.md	Contributor onboarding: skills map and role-based reading order

---

API

• swagger.yaml / swagger.json — OpenAPI spec for the WebRTC offer endpoint (POST /webrtc/offer).
• Other endpoints (/ws, /health, /ready, /start, /sessions, etc.) are described in SYSTEM_ARCHITECTURE.md and DEPLOYMENT.md.

Documentation

Overview

Package docs Code generated by swaggo/swag. DO NOT EDIT

Index

• Variables

Variables

var SwaggerInfo = &swag.Spec{
	Version:          "1.0",
	Host:             "localhost:8080",
	BasePath:         "/api/v1",
	Schemes:          []string{},
	Title:            "Voxray API",
	Description:      "Voxray voice pipeline server: WebSocket and WebRTC transport endpoints.",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it