Deepgram Rust SDK

A Community Rust SDK for Deepgram. Start building with our powerful transcription & speech understanding API.

SDK Documentation

This SDK implements the Deepgram API found at https://developers.deepgram.com.

Documentation and examples can be found on our Docs.rs page.

Quick Start

Check out the examples folder for practical code examples showing how to use the SDK.

Authentication

🔑 To access the Deepgram API you will need a free Deepgram API Key.

There are two ways to authenticate with the Deepgram API:

1. API Key: This is the simplest method. You can get a free API key from the Deepgram Console.

   use deepgram::Deepgram;
   
   let dg = Deepgram::new("YOUR_DEEPGRAM_API_KEY");

2. Temporary Tokens: If you are building an application where you need to grant temporary access to the Deepgram API, you can use temporary tokens. This is useful for client-side applications where you don't want to expose your API key.

   You can create temporary tokens using the Deepgram API. Learn more about token-based authentication.

   use deepgram::Deepgram;
   
   let dg = Deepgram::with_temp_token("YOUR_TEMPORARY_TOKEN");

Current Status

This SDK is currently Community owned but is moving to a stable 1.0 version soon.

Install

From within your Cargo project directory, run the following command:

cargo add deepgram

You will also probably need to install tokio:

cargo add tokio --features full

Development and Contributing

Interested in contributing? We ❤️ pull requests!

To make sure our community is safe for all, be sure to review and agree to our Code of Conduct and review our Contributing Guidelines.

Build the SDK

cargo build

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

• Open an issue in this repository
• Join the Deepgram Github Discussions Community
• Join the Deepgram Discord Community