Deepgram
Transcribe audio and generate speech with Deepgram's AI-powered APIs.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("deepgram", "text_to_speech", {
"text": "<text>",
"model": "aura-asteria-en"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Deepgram answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "deepgram-text-to-speech",
name: "Deepgram: Text to Speech",
description: "Calls Deepgram when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("deepgram", {
"action": "text_to_speech",
"text": "<text>",
"model": "aura-asteria-en"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/deepgram/text_to_speech" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"text":"<text>","model":"aura-asteria-en"}}'Actions
text_to_speechin catalog
Text to Speech. Converts text to audio file.
| Input | Type | Description |
|---|---|---|
textrequired | long text | Text |
modelrequired | one of "aura-asteria-en" | "aura-luna-en" | "aura-stella-en" | "aura-athena-en" | "aura-hera-en" | "aura-orion-en" | "aura-arcas-en" | "aura-perseus-en" | "aura-angus-en" | "aura-orpheus-en" | "aura-helios-en" | "aura-zeus-en" | Voice |
encodingoptional | one of "linear16" | "flac" | "mulaw" | "alaw" | "mp3" | "opus" | "aac" | Output Format |
create_summary
Create Summary. Produces a summary of the content from an audio file.
| Input | Type | Description |
|---|---|---|
audioFilerequired | file | Audio File |
modeloptional | one of "nova-3" | "nova-3-general" | "nova-3-medical" | "nova-2" | "nova-2-general" | "nova-2-meeting" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-voicemail" | "nova-2-video" | "nova-2-medical" | "nova-2-drivethru" | Model |
languageoptional | one of "bg" | "ca" | "zh" | "zh-CN" | "zh-TW" | "zh-HK" | "zh-Hans" | "zh-Hant" | "cs" | "da" | "da-DK" | "nl" | en |
fallbackToTranscriptoptional | boolean | Return full transcript if summary is not available. |
create_transcription_callback
Create Transcription (Callback). Creates a transcription using a callback URL.
| Input | Type | Description |
|---|---|---|
audioFilerequired | file | Audio File |
modeloptional | one of "nova-3" | "nova-3-general" | "nova-3-medical" | "nova-2" | "nova-2-general" | "nova-2-meeting" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-voicemail" | "nova-2-video" | "nova-2-medical" | "nova-2-drivethru" | Model |
languageoptional | one of "bg" | "ca" | "zh" | "zh-CN" | "zh-TW" | "zh-HK" | "zh-Hans" | "zh-Hant" | "cs" | "da" | "da-DK" | "nl" | en |
callbackUrlrequired | text | URL to receive the transcription when ready. |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
list_projects
List Projects. Retrieves a list of all projects associated with the account.
No input.
Details
- Id
deepgram- Category
- AI and ML
- Tags
- speech, transcription, tts, audio, ai
- Package
@activepieces/piece-deepgram@0.1.4- Tier
- Built in