Skip to content

docs: add Cartesia Turns STT service for pipecat PR #4552#846

Merged
markbackman merged 1 commit into
mainfrom
docs/pr-4552
May 29, 2026
Merged

docs: add Cartesia Turns STT service for pipecat PR #4552#846
markbackman merged 1 commit into
mainfrom
docs/pr-4552

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4552.

Changes

New service page

  • api-reference/server/services/stt/cartesia-turns.mdx — Complete documentation for CartesiaTurnsSTTService, which uses the Cartesia Ink-2 model via the v2 turn-based WebSocket API (/stt/turns/websocket). Covers:
    • Overview of turn-based protocol (turn.start → turn.update → turn.eager_end → turn.resume → turn.end)
    • Configuration parameters (api_key, url, sample_rate, should_interrupt, watchdog_min_timeout, extra_headers, settings)
    • Settings table (model: ink-2, language: English-only)
    • Usage examples with basic setup, custom configuration, and event handlers
    • Turn-based protocol flow diagram
    • Notes on English-only support, no runtime model switching, watchdog for dangling turns
    • Event handlers table (on_turn_start, on_turn_update, on_turn_eager_end, on_turn_resume, on_turn_end, plus connection events)

Navigation updates

  • docs.json — Added api-reference/server/services/stt/cartesia-turns to Speech-to-Text group (alphabetically after cartesia)
  • supported-services.mdx — Added Cartesia Turns entry to STT table with installation command uv add "pipecat-ai[cartesia]"

Gaps identified

None — all relevant source files were mapped and documented.

@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes pipecat labels May 28, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 28, 2026

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

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview May 28, 2026, 1:33 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Add documentation for CartesiaTurnsSTTService, which uses the Cartesia
Ink-2 model via the v2 turn-based WebSocket API. Rather than a separate
page, it's documented alongside CartesiaSTTService on the existing
Cartesia STT page, following the multi-service layout used for Deepgram.
@markbackman markbackman merged commit 324783d into main May 29, 2026
2 checks passed
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 pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant