mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-27 11:56:43 +02:00
143 lines
4.6 KiB
Markdown
143 lines
4.6 KiB
Markdown
---
|
|
summary: "Deepgram transcription for inbound voice notes"
|
|
read_when:
|
|
- You want Deepgram speech-to-text for audio attachments
|
|
- You need a quick Deepgram config example
|
|
title: "Deepgram"
|
|
---
|
|
|
|
# Deepgram (Audio Transcription)
|
|
|
|
Deepgram is a speech-to-text API. In OpenClaw it is used for **inbound audio/voice note
|
|
transcription** via `tools.media.audio`.
|
|
|
|
When enabled, OpenClaw uploads the audio file to Deepgram and injects the transcript
|
|
into the reply pipeline (`{{Transcript}}` + `[Audio]` block). This is **not streaming**;
|
|
it uses the pre-recorded transcription endpoint.
|
|
|
|
| Detail | Value |
|
|
| ------------- | ---------------------------------------------------------- |
|
|
| Website | [deepgram.com](https://deepgram.com) |
|
|
| Docs | [developers.deepgram.com](https://developers.deepgram.com) |
|
|
| Auth | `DEEPGRAM_API_KEY` |
|
|
| Default model | `nova-3` |
|
|
|
|
## Getting started
|
|
|
|
<Steps>
|
|
<Step title="Set your API key">
|
|
Add your Deepgram API key to the environment:
|
|
|
|
```
|
|
DEEPGRAM_API_KEY=dg_...
|
|
```
|
|
|
|
</Step>
|
|
<Step title="Enable the audio provider">
|
|
```json5
|
|
{
|
|
tools: {
|
|
media: {
|
|
audio: {
|
|
enabled: true,
|
|
models: [{ provider: "deepgram", model: "nova-3" }],
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
</Step>
|
|
<Step title="Send a voice note">
|
|
Send an audio message through any connected channel. OpenClaw transcribes it
|
|
via Deepgram and injects the transcript into the reply pipeline.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Configuration options
|
|
|
|
| Option | Path | Description |
|
|
| ----------------- | ------------------------------------------------------------ | ------------------------------------- |
|
|
| `model` | `tools.media.audio.models[].model` | Deepgram model id (default: `nova-3`) |
|
|
| `language` | `tools.media.audio.models[].language` | Language hint (optional) |
|
|
| `detect_language` | `tools.media.audio.providerOptions.deepgram.detect_language` | Enable language detection (optional) |
|
|
| `punctuate` | `tools.media.audio.providerOptions.deepgram.punctuate` | Enable punctuation (optional) |
|
|
| `smart_format` | `tools.media.audio.providerOptions.deepgram.smart_format` | Enable smart formatting (optional) |
|
|
|
|
<Tabs>
|
|
<Tab title="With language hint">
|
|
```json5
|
|
{
|
|
tools: {
|
|
media: {
|
|
audio: {
|
|
enabled: true,
|
|
models: [{ provider: "deepgram", model: "nova-3", language: "en" }],
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
</Tab>
|
|
<Tab title="With Deepgram options">
|
|
```json5
|
|
{
|
|
tools: {
|
|
media: {
|
|
audio: {
|
|
enabled: true,
|
|
providerOptions: {
|
|
deepgram: {
|
|
detect_language: true,
|
|
punctuate: true,
|
|
smart_format: true,
|
|
},
|
|
},
|
|
models: [{ provider: "deepgram", model: "nova-3" }],
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Notes
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Authentication">
|
|
Authentication follows the standard provider auth order. `DEEPGRAM_API_KEY` is
|
|
the simplest path.
|
|
</Accordion>
|
|
<Accordion title="Proxy and custom endpoints">
|
|
Override endpoints or headers with `tools.media.audio.baseUrl` and
|
|
`tools.media.audio.headers` when using a proxy.
|
|
</Accordion>
|
|
<Accordion title="Output behavior">
|
|
Output follows the same audio rules as other providers (size caps, timeouts,
|
|
transcript injection).
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<Note>
|
|
Deepgram transcription is **pre-recorded only** (not real-time streaming). OpenClaw
|
|
uploads the complete audio file and waits for the full transcript before injecting
|
|
it into the conversation.
|
|
</Note>
|
|
|
|
## Related
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Media tools" href="/tools/media" icon="photo-film">
|
|
Audio, image, and video processing pipeline overview.
|
|
</Card>
|
|
<Card title="Configuration" href="/configuration" icon="gear">
|
|
Full config reference including media tool settings.
|
|
</Card>
|
|
<Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
|
|
Common issues and debugging steps.
|
|
</Card>
|
|
<Card title="FAQ" href="/help/faq" icon="circle-question">
|
|
Frequently asked questions about OpenClaw setup.
|
|
</Card>
|
|
</CardGroup>
|