Skip to content

docs: update for pipecat PR #4092#645

Open
markbackman wants to merge 1 commit intomainfrom
docs/pr-4092
Open

docs: update for pipecat PR #4092#645
markbackman wants to merge 1 commit intomainfrom
docs/pr-4092

Conversation

@markbackman
Copy link
Contributor

Automated documentation update for pipecat PR #4092.

Changes

  • Created server/services/tts/smallest.mdx — Full documentation for Smallest AI TTS service including:

    • Overview with service description and links to API reference and example
    • Installation instructions (pip install "pipecat-ai[smallest]")
    • Prerequisites (API key setup)
    • Configuration parameters (api_key, base_url, sample_rate, settings)
    • Settings table with all runtime-configurable options (model, voice, language, speed, consistency, similarity, enhancement)
    • Usage examples (basic setup, voice customization, Lightning V2 model, runtime settings updates)
    • Notes about WebSocket streaming, keepalive, model-specific parameters, and language support
    • Event handlers documentation (on_connected, on_disconnected, on_connection_error)
  • Updated docs.json — Added server/services/tts/smallest to Text-to-Speech navigation group (alphabetically between sarvam and speechmatics)

  • Updated server/services/supported-services.mdx — Added Smallest AI to TTS services table (alphabetically between Sarvam and Speechmatics)

Gaps identified

None — all relevant files from PR #4092 were mapped and documented.

Add documentation for SmallestTTSService, a WebSocket-based TTS
integration with Smallest AI's Waves API.

- Created server/services/tts/smallest.mdx with full configuration,
  usage examples, and event handler documentation
- Added to docs.json navigation (Text-to-Speech group, alphabetically)
- Added to supported-services.mdx (TTS table, alphabetically)

Covers:
- Constructor parameters (api_key, base_url, sample_rate, settings)
- SmallestTTSSettings with runtime-updatable fields
- SmallestTTSModel enum (LIGHTNING_V2, LIGHTNING_V3_1)
- Event handlers (on_connected, on_connection_error, on_disconnected)
- WebSocket keepalive behavior and model-specific parameters
@markbackman markbackman added the auto-docs Automated documentation update from pipecat source changes label Mar 24, 2026
@mintlify
Copy link

mintlify bot commented Mar 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Mar 24, 2026, 4:14 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant