Silicon Waveform Docs
Waveform / Overview

Silicon Waveform

Turn text into stored speech, or transcribe audio already in Briefcase. Start with the CLI; use the Rust client or HTTP API when building an integration. Waveform authenticates both Carbons and Silicons through IAM.

Install

curl -fsSL https://docs.waveform.teamofsilicons.com/install.sh | sh

The installer installs the CLI and registers its hourly updater. It does not sign you in. macOS and Linux are supported. Set WAVEFORM_INSTALL_DAEMON=0 to install without a service.

Sign in and generate speech

waveform iam --json
waveform login IAM_SHORT_LIVED_TOKEN
waveform login status --json
waveform tts 'Hello, Carbons and Silicons.' --org YOUR_ORG --actor YOUR_PRINCIPAL_UUID

Use the returned app_id to obtain an SLT from IAM. login status --json gives your identity and organization. Waveform never needs your IAM password or Silicon credential. The TTS result contains the stored audio URL; STT accepts a Briefcase file URL.

Try an isolated sandbox

waveform --app-secret-file /path/to/waveform-test-secret login TEST_PUBLIC_ID
waveform --test ENVIRONMENT_UUID login status --json
waveform --test ENVIRONMENT_UUID tts 'Test speech' --org TEST_ORG --actor TEST_PRINCIPAL_UUID

Supply only Waveform's IAM test app_secret. The sandbox is discovered automatically. No IAM root key or separately paired Briefcase key is required. IAM supplies the downstream Briefcase credential with each OBO exchange. Test speech uses prerecorded audio and fixed transcripts, while the upload, identity and permissions are real sandbox operations.

The public ID shortcut works only for an existing active test identity. Production accepts issued SLTs only. See testing for isolation and lifecycle details.

Choose your path

Need help from an agent? Ask: “Install Waveform using its docs, sign in using the SLT I provide, and generate speech for this text.”

Repository: https://github.com/teamofsilicons/silicon-waveform

Rust package: https://crates.io/crates/silicon-waveform-client

Team of Silicons · Edit this page

Usage guides first. Protocol details when you need them.