Generating and Saving Transcripts From the Terminal
It can be helpful to know how to see and save Deepgram transcripts directly in your terminal. Learn how to use bash commands and scripts to execute directly in your terminal.
Before you run the code, you’ll need to do a few things.
Before you can use Deepgram, you’ll need to create a Deepgram account. Signup is free and includes $200 in free credit and access to all of Deepgram’s features!
Before you start, you’ll need to follow the steps in the Make Your First API Request guide to obtain a Deepgram API key, and configure your environment if you are choosing to use a Deepgram SDK.
In this guide, we use jq, which is an excellent command-line utility that allows you to display and manipulate JSON data, so you will also need to install jq.
Open your terminal, and run the following curl command:
Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key.
Let’s look more closely at this request:
--request POST: An HTTP request with the POST method.--header 'Authorization: Token YOUR_DEEPGRAM_API_KEY': Includes authorization details and links the request with your Deepgram account and Project.--header 'Content-Type: application/json': JSON data that will be sent with this request.--data '{"url":"<https://static.deepgram.com/examples/nasa-spacewalk-interview.wav>"}': JSON data sent to Deepgram (an object containing one URL parameter).--url 'https://api.deepgram.com/v1/listen?punctuate=true': URL to which the request should be made (Deepgram’s endpoint). punctuate=true enables the punctuation feature.\: Allows you to break one command over several lines for readability.When you run this command and it is finished processing (often after only a few seconds), you’ll receive a JSON response that looks similar to the following:
This may look daunting, so let’s look at a way to make both our curl request and our response easier to read.
Now that you’ve seen a full curl request and understand the required parameters, let’s look at a more concise way to make the same request:
In this example, notice:
curl command.--header is shortened to -H--data is shortened to -d.To make the JSON response more readable, you can use jq, which is an excellent command-line utility that allows you to display and manipulate JSON data.
In the terminal, a pipe (|) is often used to send the output of one command as an input for a second command. jq expects some JSON as input, plus an expression to describe how to display it.
The following jq expression will extract just the transcript from the returned data object:
| jq '.results.channels[0].alternatives[0].transcript'
To use it, add it to the end of your curl request:
Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key.
When you run this command and it is finished processing (often after only a few seconds), you’ll receive a JSON response that looks similar to the following:
Once you have the transcript extracted and formatted using jq, you can redirect the output to a new file by appending > output.txt to any command that prints to the terminal. For example:
To process multiple files, you can create .sh files containing multiple lines of bash script to execute from your terminal.
Create a new file called transcripts.sh, and open it in a code editor. Populate it with the following:
Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key.
In this file, notice:
The first line (#!/bin/bash) is a shebang and specifies which program should be called to run the script. In this case, bash.
urls is a variable containing an array with three URLs. The arrays use parentheses, and items are separated by only one space.
dg_features and dg_key are variables you should alter for your exact use case. Note that the request, as written, uses Deepgram’s punctuation, utterances, diarize, and tier features included in the dg_features variable.
Inside the for loop:
filename extracts the last part of the URL (the filename), which will later be used to name the output file.curl command is the same as before, but with variables interpolated. The output is stored in a new variable called RESPONSE.RESPONSE is sent to jq, and then redirected into a new text file.Run the file in your terminal:
jq is a remarkable powerful tool that you can use to format data in more advanced ways. For example, the following expression will loop through the results.utterances array and format a string for each item, interpolating the speaker identifier and transcript text:
When you run a previous curl command with this jq appended and it is finished processing, you’ll receive a JSON response formatted in the following way: