Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
119 commits
Select commit Hold shift + click to select a range
d2d634f
pipecat draft doc
lgavincrl Nov 27, 2025
266ae79
PC tweak
lgavincrl Nov 27, 2025
06a3265
LiveKit draft
lgavincrl Nov 27, 2025
14fe38f
integrations sidebar added
lgavincrl Nov 27, 2025
00488f4
Main sidebar - integrations added
lgavincrl Nov 27, 2025
1c6f428
sidebar fix??
lgavincrl Nov 27, 2025
c1bb590
Update readme and contributing files (#163)
lgavincrl Nov 27, 2025
2a5df49
Update medical domain languages availability in prod and preview (#164)
smvenkateshc Nov 27, 2025
c35e6d5
Overview page added
lgavincrl Nov 28, 2025
3202dd8
feat: add overview page and update integration docs
lgavincrl Nov 28, 2025
2924667
integrations sidebar config update
lgavincrl Nov 28, 2025
d091f16
hopeful fix#1
lgavincrl Nov 28, 2025
22d4ad5
livekit intro
lgavincrl Nov 28, 2025
cd4f190
vapi description error correction
lgavincrl Nov 28, 2025
2ce9772
fmt fix
lgavincrl Nov 28, 2025
0bfb158
feat: add LiveKit int intro
lgavincrl Nov 28, 2025
e183f19
add livekit-speechmatics stt plugin guide
lgavincrl Nov 28, 2025
87c5129
add livekit sidebar
lgavincrl Nov 28, 2025
e3ad1fd
another sidebar + dropdown test
lgavincrl Nov 28, 2025
8132920
another try
lgavincrl Nov 28, 2025
9dfad28
and again
lgavincrl Nov 28, 2025
dde5fd0
stt-plugin livekit guide page
lgavincrl Nov 28, 2025
2cd7254
sb-int fix
lgavincrl Nov 28, 2025
0eb349a
doc id update
lgavincrl Nov 28, 2025
ca2fd20
LK poss sidebar
lgavincrl Nov 28, 2025
1ec9bfc
1st Draft Docs for all 3 integrations of stt
lgavincrl Nov 28, 2025
a3bf36a
removed / from if
lgavincrl Nov 28, 2025
5922dfd
pc / removed from id
lgavincrl Nov 28, 2025
f958dd6
formatting error corrections
lgavincrl Nov 28, 2025
d2b52fa
fix
lgavincrl Nov 28, 2025
613f301
sidebar please work
lgavincrl Nov 28, 2025
d0c881a
sidebar p->P
lgavincrl Nov 28, 2025
c25c8e4
build item
lgavincrl Nov 28, 2025
43d4809
..... more
lgavincrl Nov 28, 2025
6e9794d
Removal of pc and lk from main sidebar,
lgavincrl Nov 30, 2025
ce9771a
livekit agents with stt update
lgavincrl Dec 2, 2025
f889d07
livekit sidebar update
lgavincrl Dec 2, 2025
957b4c6
small changes
lgavincrl Dec 2, 2025
2d57bc6
remove separate stt plugin
lgavincrl Dec 2, 2025
92f0499
Link cards for integration partners
lgavincrl Dec 2, 2025
dfaf084
ux improvements
lgavincrl Dec 2, 2025
09d5ca7
ui/ux improvements
lgavincrl Dec 2, 2025
3de3a6a
Sidebar change
lgavincrl Dec 2, 2025
ac3cde7
Formatting, design and content upgrades!!
lgavincrl Dec 2, 2025
3831cbf
added sdk dropdown under integrations
lgavincrl Dec 3, 2025
eb6f6b3
added batch python sdk
lgavincrl Dec 3, 2025
768fb49
added rt python sdk
lgavincrl Dec 3, 2025
5010e21
Updated file paths and IDs to use 'integrations-and-sdks' naming conv…
lgavincrl Dec 3, 2025
b5eeb4c
ux improvement
lgavincrl Dec 3, 2025
7247690
shuffle - improve visibility of integrations
lgavincrl Dec 3, 2025
773d27b
Remove sdk from under get started
lgavincrl Dec 3, 2025
2360bf7
Add Flow
lgavincrl Dec 3, 2025
4c57143
tweaks
lgavincrl Dec 3, 2025
00580b0
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
4e761f6
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
a7bde84
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
e55041b
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
10d02c6
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
562231c
Apply suggestion from @TudorCRL
lgavincrl Dec 4, 2025
acfb55c
Correction: sst ->stt
lgavincrl Dec 4, 2025
0eaf825
Revert "Correction: sst ->stt"
lgavincrl Dec 4, 2025
078b177
Update capitalization and formatting in Vapi integration docs
lgavincrl Dec 4, 2025
615705f
Standardize terminology and capitalisation
lgavincrl Dec 4, 2025
3abc19c
Standardise terminology and update LiveKit integration details
lgavincrl Dec 4, 2025
85fef4f
Update integrations overview page structure and standardise integrati…
lgavincrl Dec 5, 2025
a441e37
Reorganise SDK section to group Voice Agents with STT SDKs and add de…
lgavincrl Dec 5, 2025
79f7d54
Update SDK documentation structure and fix integration formatting
lgavincrl Dec 5, 2025
a78dc2b
Standardise formatting in integration descriptions by consolidating m…
lgavincrl Dec 5, 2025
ec9ff7f
Consolidate multi-line descriptions in voice agent integration cards …
lgavincrl Dec 5, 2025
5ceb479
Best for cards
lgavincrl Dec 5, 2025
22eadb9
Remove "Best for" recommendations from voice agent integration card d…
lgavincrl Dec 5, 2025
b4e8992
Monior a
lgavincrl Dec 5, 2025
59266bb
Add voice agents SDK documentation with quickstart guide and configur…
lgavincrl Dec 8, 2025
f86e0a8
Update docs/integrations-and-sdks/vapi.mdx
lgavincrl Dec 8, 2025
5a7c344
Update docs/integrations-and-sdks/vapi.mdx
lgavincrl Dec 8, 2025
e54d88e
capitalisation in Vapi feature list items to use sentence case
lgavincrl Dec 8, 2025
a924f61
Remove empty placeholder LinkCard
lgavincrl Dec 8, 2025
93944f5
Update voice SDK documentation titles and descriptions to use sentenc…
lgavincrl Dec 8, 2025
5847d4e
use consistent terminology for SDK and apply sentence case to heading
lgavincrl Dec 8, 2025
ae7acd8
Remove trailing period from Vapi integration card description for con…
lgavincrl Dec 8, 2025
7e32910
Format requirements as bullet list and clarify optional API key confi…
lgavincrl Dec 8, 2025
28ff0c4
Move SDKs doc from category to single doc page and flatten sidebar st…
lgavincrl Dec 8, 2025
9e59ed2
Update integrations overview page description and remove duplicate Vo…
lgavincrl Dec 8, 2025
a25244d
Update SDK card icons to use devicon library and reorganize SDK listi…
lgavincrl Dec 8, 2025
e769f4a
Update homepage to reference Voice SDK instead of Flow service and up…
lgavincrl Dec 9, 2025
e8834ee
Updatw to use consistent formatting, add direction column prop, and r…
lgavincrl Dec 9, 2025
ce33ed9
Update sidebar to reference overview page instead of quickstart and a…
lgavincrl Dec 9, 2025
88208a2
Update features page to use sentence case headings and consistent cod…
lgavincrl Dec 9, 2025
e527e53
Add voice agents overview page with Voice SDK quickstart guide and co…
lgavincrl Dec 9, 2025
99bd12d
Remove quickstart page as content has been consolidated into overview…
lgavincrl Dec 9, 2025
a5c5472
Move external link icon from title to top-right corner of card and re…
lgavincrl Dec 9, 2025
0dd83b9
Add LiveKit, pipecat and vapi logo images
lgavincrl Dec 9, 2025
19154de
Add pipecat and vapi integration logo images
lgavincrl Dec 9, 2025
c7be23b
Fix typo in Voice SDK title and add consistent icon sizing across SDK…
lgavincrl Dec 10, 2025
1f64254
Add link to supported languages
lgavincrl Dec 10, 2025
2c1cc92
Update welcome page to include text-to-speech capabilities and add TT…
lgavincrl Dec 10, 2025
dc58010
Add TTS quickstart card and update voice agent link to overview page
lgavincrl Dec 10, 2025
42afc24
Update voice agents overview page with improved heading structure and…
lgavincrl Dec 10, 2025
82a9541
Update Voice SDK code examples to use consistent environment variable…
lgavincrl Dec 10, 2025
7d6ce9b
Update text-to-speech description
lgavincrl Dec 10, 2025
ade5840
Add Python SDK and Academy cards to quickstart page, update voice age…
lgavincrl Dec 10, 2025
62b1ead
Add label to quickstart sidebar item for consistent navigation display
lgavincrl Dec 10, 2025
8933c9f
Improve voice agent features documentation formatting by breaking par…
lgavincrl Dec 10, 2025
b6413cf
Replace & with and
lgavincrl Dec 10, 2025
4f3cbb4
Standardise SDK card descriptions and language capitalization across …
lgavincrl Dec 10, 2025
a618668
Fix trailing whitespace and formatting inconsistencies in voice agent…
lgavincrl Dec 10, 2025
d51fa30
Update Voice SDK description to emphasize responsive voice agent capa…
lgavincrl Dec 10, 2025
aa7e35b
replace &
lgavincrl Dec 10, 2025
f93cd10
Merge branch 'main' into updates-to-integrations-sdk-docs
lgavincrl Dec 10, 2025
c500b04
Update docs/integrations-and-sdks/index.mdx
lgavincrl Dec 10, 2025
33efd4e
Add DevIcon component in src
lgavincrl Dec 10, 2025
79dfdf9
Replace inline devicon elements with DevIcon component across SDKs
lgavincrl Dec 10, 2025
9b0051b
Repair sidebar build
lgavincrl Dec 10, 2025
615140f
Remove id field from integrations-and-sdks index frontmatter and upda…
lgavincrl Dec 10, 2025
e2250b9
Exclude flow from documentation generation
lgavincrl Dec 12, 2025
8024e6a
Remove flow sidebar import
lgavincrl Dec 12, 2025
b7688d5
Remove Flow redirects from old site routes and Vercel configuration
lgavincrl Dec 12, 2025
74d2c7b
Remove Flow refs from stt docs
lgavincrl Dec 12, 2025
7512c10
Remove broken link
lgavincrl Dec 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions docs/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,14 @@ pagination_next: null
description: Take your first steps with the Speechmatics API.
---
import { LinkCard } from "@site/src/theme/LinkCard";
import DevIcon from '@site/src/components/devicon';
import { Flex, Grid } from "@radix-ui/themes";
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces } from "lucide-react";
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces, Speech, GraduationCap } from "lucide-react";
import Head from '@docusaurus/Head';

<Head>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css" />
</Head>

# Quickstart

Expand All @@ -30,9 +36,15 @@ The easiest way to try our products is via the [web portal](https://portal.speec
/>
<LinkCard
title="Build a voice agent"
description="Build conversational AI agents with ease using the Flow API"
description="Build conversational AI agents with ease using the Voice SDK"
icon={<BotMessageSquare/>}
href="/voice-agents-flow/"
href="/voice-agents/overview"
/>
<LinkCard
title="Generate speech from text"
description="Use the TTS API to convert text to speech"
icon={<Speech/>}
href="/text-to-speech/quickstart"
/>
</Flex>

Expand All @@ -51,4 +63,16 @@ The easiest way to try our products is via the [web portal](https://portal.speec
icon={<Braces/>}
href="https://github.com/speechmatics/speechmatics-js-sdk"
/>
<LinkCard
title="Python SDK"
description="Use our Python SDK to access all of our APIs"
icon={<DevIcon name="python" />}
href="https://github.com/speechmatics/speechmatics-python-sdk"
/>
<LinkCard
title="Speechmatics Academy"
description="To learn more or see some examples, visit the Speechmatics Academy"
icon={<GraduationCap/>}
href="https://github.com/speechmatics/speechmatics-academy"
/>
</Grid>
1 change: 1 addition & 0 deletions docs/get-started/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export default {
{
type: "doc",
id: "get-started/quickstart",
label: "Quickstart",
},
{
type: "doc",
Expand Down
22 changes: 15 additions & 7 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
sidebar_position: 1
title: Welcome
description: Enterprise-grade APIs for speech-to-text and voice AI agents.
description: Enterprise-grade APIs for speech-to-text, text-to-speech, and voice AI agents.
hide_table_of_contents: true
pagination_prev: null
pagination_next: null
---

import { LinkCard } from "@site/src/theme/LinkCard";
import { ChevronsRightIcon, FileAudio, BotMessageSquare, } from "lucide-react";
import { ChevronsRightIcon, FileAudio, BotMessageSquare, Speech } from "lucide-react";
import { Box, Flex, Card, Grid, Inset } from "@radix-ui/themes";

# Welcome to Speechmatics
Expand All @@ -31,7 +31,8 @@ With Speechmatics, you can:

- Receive immediate and continuous text transcriptions from live audio streams or calls (real-time transcription)
- Generate complete transcripts from recorded audio files (batch transcription)
- Build voice AI agents that naturally converse with your users (Flow service)
- Build and power your applications with responsive, real-time, voice AI using our Voice SDK
- Transform your text into speech using our Text-to-Speech API
- Choose flexible deployment options: use our managed SaaS platform or host Speechmatics APIs within your infrastructure (on-prem)

## Developer quickstart
Expand All @@ -54,9 +55,16 @@ With Speechmatics, you can:
<LinkCard
icon={<BotMessageSquare/>}
title="Build a voice agent"
description="Use our Flow service to build conversational AI agents with ease"
description="Use our Voice SDK to build voice agents with ease"
direction="column"
href="/voice-agents-flow"
href="/voice-agents/overview"
/>
<LinkCard
icon={<Speech/>}
title="Generate speech from text"
description="Use our TTS API to generate speech from text"
direction="column"
href="/text-to-speech/quickstart"
/>
</Flex>

Expand Down Expand Up @@ -96,8 +104,8 @@ With Speechmatics, you can:
<Grid columns={{initial: "1", md: "2"}} gap="3">
<LinkCard
title="Voice agent app"
description="Conversational AI with React Native and Flow"
href="/voice-agents-flow/guides/react-native"
description="Build your own responsive voice agent with our Voice SDK"
href="/voice-agents/overview"
/>
<LinkCard
title="Realtime transcription with NextJS"
Expand Down
129 changes: 55 additions & 74 deletions docs/integrations-and-sdks/index.mdx
Original file line number Diff line number Diff line change
@@ -1,128 +1,109 @@
---
id: Overview
description: Discover how to connect to Speechmatics via integrations and SDKs.
description: Discover which integrations and SDKs to add Speechmatics' STT, TTS or voice agents to your applications.
---

import { LinkCard } from "@site/src/theme/LinkCard";
import DevIcon from '@site/src/components/devicon';
import { Flex, Grid } from "@radix-ui/themes";
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces } from "lucide-react";
import { } from "lucide-react";
import Head from '@docusaurus/Head';

<Head>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css" />
</Head>

Discover which integrations and SDKs to use to add Speechmatics speech and voice agents to your stack.

# Overview

Use this page to quickly choose how you connect to Speechmatics: through popular voice agent platforms, or directly from your code using our SDKs. Start with the option that best matches your current stack, then follow its quickstart.

## Voice agent orchestrator integrations

Choose an integration to build accurate, low-latency voice agents rapidly with the Speechmatics API available in these frameworks.

<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
<Grid columns="3" gap="3">
<LinkCard
title="Vapi"
description="Turnkey voice agent platform. Deploy fast with no code"
icon={<BotMessageSquare/>}
description="Turnkey voice agent platform. Deploy fast with no code. Rapid prototyping. Best for: non-technical builders."
icon={<img src="/img/integration-logos/vapi.png" alt="Vapi logo" width="28px" height="28px" />}
href="/integrations-and-sdks/vapi"
/>
<LinkCard
title="LiveKit"
description="Open-source framework for building agents with LiveKit’s WebRTC infra"
icon={<ChevronsRightIcon/>}
description="Open-source framework for building agents with LiveKit’s WebRTC infra. Simple setup. Best for: engineers."
icon={<img src="/img/integration-logos/livekit.png" alt="LiveKit logo" width="28px" height="28px" />}
href="/integrations-and-sdks/livekit"
/>
<LinkCard
title="Pipecat"
description="Open-source framework with full control of the voice pipeline in code"
icon={<FileAudio/>}
href="/integrations-and-sdks/pipecat"
/>
<LinkCard
title="Best for"
description="Non-technical builders, rapid prototyping"
icon={<BotMessageSquare/>}
href="/integrations-and-sdks/vapi"
/>
<LinkCard
title="Best for"
description="Engineers, simple setup"
icon={<ChevronsRightIcon/>}
href="/integrations-and-sdks/livekit"
/>
<LinkCard
title="Best for:"
description="Power builders, complex agents"
icon={<FileAudio/>}
description="Open-source framework with full control of the voice pipeline in code. Complex agents. Best for: power builders."
icon={<img src="/img/integration-logos/pipecat.png" alt="Pipecat logo" width="28px" height="28px" />}
href="/integrations-and-sdks/pipecat"
/>

</Grid>



## SDKs

Use an SDK if you want to call Speechmatics directly from your own services or applications.

### Speech to text

<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3" row="3">
<Grid columns="3" gap="3">
<LinkCard
title="Python SDK (Voice Agents)"
description="Build voice agents in Python"
icon={<ChevronsRightIcon/>}
title="Voice SDK (Python)"
description="Build responsive voice agents"
icon={<DevIcon name="python" />}
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/voice"
/>
<LinkCard
title="Python SDK (Realtime)"
description="Stream audio and receive instant transcripts in Python"
icon={<BotMessageSquare/>}
<LinkCard
title="Realtime (Python)"
description="Stream audio and receive instant transcripts"
icon={<DevIcon name="python" />}
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/rt"
/>
<LinkCard
title="JavaScript SDK (Realtime)"
description="Stream audio and receive instant transcripts in JavaScript"
icon={<BotMessageSquare/>}
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/rt"
/>
<LinkCard
title=".NET SDK (Realtime)"
description="Stream audio and receive instant transcripts in .NET"
icon={<FileAudio/>}
href="https://github.com/speechmatics/speechmatics-dotnet-community-sdk"
/>
<LinkCard
title="Python SDK (Batch)"
description="Input audio files and receive transcripts in Python"
icon={<ChevronsRightIcon/>}
<LinkCard
title="Batch (Python)"
description="Input audio files and receive transcripts"
icon={<DevIcon name="python" />}
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/batch"
/>
<LinkCard
title="JavaScript SDK (Batch)"
description="Input audio files and receive transcripts in JavaScript"
icon={<ChevronsRightIcon/>}
title="Realtime (JavaScript)"
description="Stream audio and receive instant transcripts"
icon={<DevIcon name="javascript" />}
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/rt"
/>
<LinkCard
title="Batch (JavaScript)"
description="Input audio files and receive transcripts"
icon={<DevIcon name="javascript" />}
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/batch"
/>
<LinkCard
title="Rust SDK (Realtime & batch)"
description="Input audio files and receive transcripts in Rust"
icon={<FileAudio/>}
title="Realtime (.NET)"
description="Stream audio and receive instant transcripts"
icon={<DevIcon name="dot-net" />}
href="https://github.com/speechmatics/speechmatics-dotnet-community-sdk"
/>
<LinkCard
title="Realtime and Batch (Rust)"
description="Input audio files and receive transcripts"
icon={<DevIcon name="rust" />}
href="https://github.com/speechmatics/speechmatics-rust-sdk"
/>
</Grid>


### Text to speech

<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
<Grid columns="3" gap="3">
<LinkCard
title="Python SDK (TTS)"
description="Convert text to speech in Python"
icon={<ChevronsRightIcon/>}
title="TTS (Python)"
description="Convert text to speech"
icon={<DevIcon name="python" />}
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/tts"
/>
</Grid>

### Voice SDK

<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
<LinkCard
title="Python SDK (Voice)"
description="Build voice agents in Python"
icon={<ChevronsRightIcon/>}
href="https://github.com/speechmatics/speechmatics-python-sdk/blob/main/sdk/voice/README.md"
/>
</Grid>
Loading