docs-site/docs

Document Vox JSON-RPC methods, SDK types, and telemetry contracts.

5|Updated Mar 17, 2026

Search Tags:#troubleshooting #json-rpc #performance-metrics #sdk-integration #warmup #vox

Ready to run

npx skills add https://github.com/arach/vox --skill docs-site-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-site/docs
Source: https://github.com/arach/vox/tree/main/docs-site/docs
Command: npx skills add https://github.com/arach/vox --skill docs-site-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Vox documentation scattered across multiple topics makes it hard to quickly learn how the voice stack works and how to use its APIs and telemetry correctly.

Core Features & Use Cases

API and RPC surface map: Find JSON-RPC method names and SDK-facing result/metrics shapes for health checks, warm-up, transcription, annotation, and synthesis.
Runtime and architecture guidance: Learn how VoxCore, VoxEngine, VoxService, the TypeScript SDK, the browser client, and the HTTP/WS bridges fit together.
Operational troubleshooting and benchmarking: Use documented warm-up flows, performance route expectations, and observability guidance to interpret latency components (cold vs hot paths) and debug stuck sessions.

Quick Start

Ask: "Summarize the key Vox RPC methods and the performance metrics fields I should inspect to diagnose slow transcription, and include a minimal operator workflow."

Frequently Asked Questions about docs-site/docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What JSON-RPC methods are available for Vox transcription and synthesis?▼

Vox JSON-RPC methods cover health checks, warm-up, transcription, annotation, and synthesis across companion WebSocket, browser HTTP bridge, and embedded Swift packages. The documentation maps these route names to their corresponding SDK type shapes and result interfaces for integration planning.

How do I diagnose slow Vox transcription using performance metrics?▼

Inspect documented Vox performance telemetry fields to compare cold versus hot path latency components during transcription. Use the warm-up flow guidance and observability metrics to interpret performance route expectations and debug slow or stuck sessions.

How does the Vox runtime architecture fit together for SDK integration?▼

The Vox runtime architecture maps VoxCore, VoxEngine, and VoxService to the TypeScript SDK, browser client, and HTTP/WS bridges. Understanding these component relationships guides correct SDK integration, route selection, and type shape mapping across companion, browser, and embedded Swift environments.

Does Vox SDK integration work with embedded Swift packages and browser HTTP bridges?▼

Vox SDK integration supports embedded Swift packages, companion WebSocket JSON-RPC, and browser HTTP bridge connections. The documentation details the specific route names, result interfaces, and telemetry contracts available for each platform target.

Why does my Vox warm-up session get stuck before transcription?▼

Vox warm-up sessions may stall when runtime relationships between VoxCore, VoxEngine, and VoxService are misconfigured or JSON-RPC health check routes fail. Use the documented warm-up flow, performance route expectations, and observability guidance to debug stuck sessions.