Skip to content

Commit 832b86b

Browse files
lgavincrlsmvenkateshcyaiir-aTudorCRLBellaT
authored
Updates to integrations sdk docs (#168)
visual improvements/ consistency updates made --------- Co-authored-by: smvenkateshc <88679930+smvenkateshc@users.noreply.github.com> Co-authored-by: Yahia <42359972+yaiir-a@users.noreply.github.com> Co-authored-by: Tudor Evans <104087420+TudorCRL@users.noreply.github.com> Co-authored-by: BTaylor <bellataylorlondon@gmail.com> Co-authored-by: Matt Nemitz <mattn@speechmatics.com>
1 parent ca72951 commit 832b86b

File tree

21 files changed

+390
-198
lines changed

21 files changed

+390
-198
lines changed

‎docs/get-started/quickstart.mdx‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ pagination_next: null
44
description: Take your first steps with the Speechmatics API.
55
---
66
import { LinkCard } from "@site/src/theme/LinkCard";
7+
import DevIcon from '@site/src/components/devicon';
78
import { Flex, Grid } from "@radix-ui/themes";
8-
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces } from "lucide-react";
9+
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces, Speech, GraduationCap } from "lucide-react";
10+
import Head from '@docusaurus/Head';
11+
12+
<Head>
13+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css" />
14+
</Head>
915

1016
# Quickstart
1117

@@ -30,9 +36,15 @@ The easiest way to try our products is via the [web portal](https://portal.speec
3036
/>
3137
<LinkCard
3238
title="Build a voice agent"
33-
description="Build conversational AI agents with ease using the Flow API"
39+
description="Build conversational AI agents with ease using the Voice SDK"
3440
icon={<BotMessageSquare/>}
35-
href="/voice-agents-flow/"
41+
href="/voice-agents/overview"
42+
/>
43+
<LinkCard
44+
title="Generate speech from text"
45+
description="Use the TTS API to convert text to speech"
46+
icon={<Speech/>}
47+
href="/text-to-speech/quickstart"
3648
/>
3749
</Flex>
3850

@@ -51,4 +63,16 @@ The easiest way to try our products is via the [web portal](https://portal.speec
5163
icon={<Braces/>}
5264
href="https://github.com/speechmatics/speechmatics-js-sdk"
5365
/>
66+
<LinkCard
67+
title="Python SDK"
68+
description="Use our Python SDK to access all of our APIs"
69+
icon={<DevIcon name="python" />}
70+
href="https://github.com/speechmatics/speechmatics-python-sdk"
71+
/>
72+
<LinkCard
73+
title="Speechmatics Academy"
74+
description="To learn more or see some examples, visit the Speechmatics Academy"
75+
icon={<GraduationCap/>}
76+
href="https://github.com/speechmatics/speechmatics-academy"
77+
/>
5478
</Grid>

‎docs/get-started/sidebar.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ export default {
1212
{
1313
type: "doc",
1414
id: "get-started/quickstart",
15+
label: "Quickstart",
1516
},
1617
{
1718
type: "doc",

‎docs/index.mdx‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
sidebar_position: 1
33
title: Welcome
4-
description: Enterprise-grade APIs for speech-to-text and voice AI agents.
4+
description: Enterprise-grade APIs for speech-to-text, text-to-speech, and voice AI agents.
55
hide_table_of_contents: true
66
pagination_prev: null
77
pagination_next: null
88
---
99

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

1414
# Welcome to Speechmatics
@@ -31,7 +31,8 @@ With Speechmatics, you can:
3131

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

3738
## Developer quickstart
@@ -54,9 +55,16 @@ With Speechmatics, you can:
5455
<LinkCard
5556
icon={<BotMessageSquare/>}
5657
title="Build a voice agent"
57-
description="Use our Flow service to build conversational AI agents with ease"
58+
description="Use our Voice SDK to build voice agents with ease"
5859
direction="column"
59-
href="/voice-agents-flow"
60+
href="/voice-agents/overview"
61+
/>
62+
<LinkCard
63+
icon={<Speech/>}
64+
title="Generate speech from text"
65+
description="Use our TTS API to generate speech from text"
66+
direction="column"
67+
href="/text-to-speech/quickstart"
6068
/>
6169
</Flex>
6270

@@ -96,8 +104,8 @@ With Speechmatics, you can:
96104
<Grid columns={{initial: "1", md: "2"}} gap="3">
97105
<LinkCard
98106
title="Voice agent app"
99-
description="Conversational AI with React Native and Flow"
100-
href="/voice-agents-flow/guides/react-native"
107+
description="Build your own responsive voice agent with our Voice SDK"
108+
href="/voice-agents/overview"
101109
/>
102110
<LinkCard
103111
title="Realtime transcription with NextJS"

‎docs/integrations-and-sdks/index.mdx‎

Lines changed: 55 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,109 @@
11
---
2-
id: Overview
3-
description: Discover how to connect to Speechmatics via integrations and SDKs.
2+
description: Discover which integrations and SDKs to add Speechmatics' STT, TTS or voice agents to your applications.
43
---
4+
55
import { LinkCard } from "@site/src/theme/LinkCard";
6+
import DevIcon from '@site/src/components/devicon';
67
import { Flex, Grid } from "@radix-ui/themes";
7-
import { ChevronsRightIcon, FileAudio, BotMessageSquare, BookOpen, Braces } from "lucide-react";
8+
import { } from "lucide-react";
9+
import Head from '@docusaurus/Head';
10+
11+
<Head>
12+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css" />
13+
</Head>
814

9-
Discover which integrations and SDKs to use to add Speechmatics speech and voice agents to your stack.
15+
16+
# Overview
1017

1118
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.
1219

1320
## Voice agent orchestrator integrations
1421

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

17-
<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
24+
<Grid columns="3" gap="3">
1825
<LinkCard
1926
title="Vapi"
20-
description="Turnkey voice agent platform. Deploy fast with no code"
21-
icon={<BotMessageSquare/>}
27+
description="Turnkey voice agent platform. Deploy fast with no code. Rapid prototyping. Best for: non-technical builders."
28+
icon={<img src="/img/integration-logos/vapi.png" alt="Vapi logo" width="28px" height="28px" />}
2229
href="/integrations-and-sdks/vapi"
2330
/>
2431
<LinkCard
2532
title="LiveKit"
26-
description="Open-source framework for building agents with LiveKit’s WebRTC infra"
27-
icon={<ChevronsRightIcon/>}
33+
description="Open-source framework for building agents with LiveKit’s WebRTC infra. Simple setup. Best for: engineers."
34+
icon={<img src="/img/integration-logos/livekit.png" alt="LiveKit logo" width="28px" height="28px" />}
2835
href="/integrations-and-sdks/livekit"
2936
/>
3037
<LinkCard
3138
title="Pipecat"
32-
description="Open-source framework with full control of the voice pipeline in code"
33-
icon={<FileAudio/>}
34-
href="/integrations-and-sdks/pipecat"
35-
/>
36-
<LinkCard
37-
title="Best for"
38-
description="Non-technical builders, rapid prototyping"
39-
icon={<BotMessageSquare/>}
40-
href="/integrations-and-sdks/vapi"
41-
/>
42-
<LinkCard
43-
title="Best for"
44-
description="Engineers, simple setup"
45-
icon={<ChevronsRightIcon/>}
46-
href="/integrations-and-sdks/livekit"
47-
/>
48-
<LinkCard
49-
title="Best for:"
50-
description="Power builders, complex agents"
51-
icon={<FileAudio/>}
39+
description="Open-source framework with full control of the voice pipeline in code. Complex agents. Best for: power builders."
40+
icon={<img src="/img/integration-logos/pipecat.png" alt="Pipecat logo" width="28px" height="28px" />}
5241
href="/integrations-and-sdks/pipecat"
5342
/>
43+
5444
</Grid>
5545

46+
47+
5648
## SDKs
5749

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

6052
### Speech to text
6153

62-
<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3" row="3">
54+
<Grid columns="3" gap="3">
6355
<LinkCard
64-
title="Python SDK (Voice Agents)"
65-
description="Build voice agents in Python"
66-
icon={<ChevronsRightIcon/>}
56+
title="Voice SDK (Python)"
57+
description="Build responsive voice agents"
58+
icon={<DevIcon name="python" />}
6759
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/voice"
6860
/>
69-
<LinkCard
70-
title="Python SDK (Realtime)"
71-
description="Stream audio and receive instant transcripts in Python"
72-
icon={<BotMessageSquare/>}
61+
<LinkCard
62+
title="Realtime (Python)"
63+
description="Stream audio and receive instant transcripts"
64+
icon={<DevIcon name="python" />}
7365
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/rt"
7466
/>
75-
<LinkCard
76-
title="JavaScript SDK (Realtime)"
77-
description="Stream audio and receive instant transcripts in JavaScript"
78-
icon={<BotMessageSquare/>}
79-
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/rt"
80-
/>
81-
<LinkCard
82-
title=".NET SDK (Realtime)"
83-
description="Stream audio and receive instant transcripts in .NET"
84-
icon={<FileAudio/>}
85-
href="https://github.com/speechmatics/speechmatics-dotnet-community-sdk"
86-
/>
87-
<LinkCard
88-
title="Python SDK (Batch)"
89-
description="Input audio files and receive transcripts in Python"
90-
icon={<ChevronsRightIcon/>}
67+
<LinkCard
68+
title="Batch (Python)"
69+
description="Input audio files and receive transcripts"
70+
icon={<DevIcon name="python" />}
9171
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/batch"
9272
/>
9373
<LinkCard
94-
title="JavaScript SDK (Batch)"
95-
description="Input audio files and receive transcripts in JavaScript"
96-
icon={<ChevronsRightIcon/>}
74+
title="Realtime (JavaScript)"
75+
description="Stream audio and receive instant transcripts"
76+
icon={<DevIcon name="javascript" />}
77+
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/rt"
78+
/>
79+
<LinkCard
80+
title="Batch (JavaScript)"
81+
description="Input audio files and receive transcripts"
82+
icon={<DevIcon name="javascript" />}
9783
href="https://github.com/speechmatics/speechmatics-javascript-sdk/tree/main/sdk/batch"
9884
/>
9985
<LinkCard
100-
title="Rust SDK (Realtime & batch)"
101-
description="Input audio files and receive transcripts in Rust"
102-
icon={<FileAudio/>}
86+
title="Realtime (.NET)"
87+
description="Stream audio and receive instant transcripts"
88+
icon={<DevIcon name="dot-net" />}
89+
href="https://github.com/speechmatics/speechmatics-dotnet-community-sdk"
90+
/>
91+
<LinkCard
92+
title="Realtime and Batch (Rust)"
93+
description="Input audio files and receive transcripts"
94+
icon={<DevIcon name="rust" />}
10395
href="https://github.com/speechmatics/speechmatics-rust-sdk"
10496
/>
10597
</Grid>
10698

10799

108100
### Text to speech
109101

110-
<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
102+
<Grid columns="3" gap="3">
111103
<LinkCard
112-
title="Python SDK (TTS)"
113-
description="Convert text to speech in Python"
114-
icon={<ChevronsRightIcon/>}
104+
title="TTS (Python)"
105+
description="Convert text to speech"
106+
icon={<DevIcon name="python" />}
115107
href="https://github.com/speechmatics/speechmatics-python-sdk/tree/main/sdk/tts"
116108
/>
117109
</Grid>
118-
119-
### Voice SDK
120-
121-
<Grid columns={{initial: "1", md: "2", lg: "3"}} gap="3">
122-
<LinkCard
123-
title="Python SDK (Voice)"
124-
description="Build voice agents in Python"
125-
icon={<ChevronsRightIcon/>}
126-
href="https://github.com/speechmatics/speechmatics-python-sdk/blob/main/sdk/voice/README.md"
127-
/>
128-
</Grid>

0 commit comments

Comments
 (0)