Documentation Index
Fetch the complete documentation index at: https://assemblyai.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
This guide will show you additional ways to make use of AssemblyAI’s Python and JavaScript SDKs.
Get Started
Before we begin, make sure you have an AssemblyAI account and an API key. You can sign up for an AssemblyAI account and get your API key from your dashboard.
How to Check and Update Your Version of the SDK
Sometimes errors are encountered because the version of the SDK you are using is not up to date. To see which version you are currently running, type this code in your terminal:
If this version is not the same as the current version of the Python SDK then you can update your version by typing this code in your terminal:pip install assemblyai --upgrade
npm info assemblyai version
npm update assemblyai --save
How to Catch and Log Errors
Catching and logging errors to the console is an easy way help you understand what is going wrong if the code does not run correctly.
Underneath the line of code where the transcript is created, transcript = transcriber.transcribe(audio_url, config), add the following code to catch and log any errors to the terminal:if transcript.error:
print(transcript.error)
Underneath the line of code where the transcript is created, const transcript = await client.transcripts.transcribe(params), add the following code to catch and log any errors to the terminal:if (transcript.status === "error") {
console.log(transcript.error);
}
How to Log the Transcript JSON and Save it in a File
If using the error handling code above then add this below it, otherwise add it after the transcript is created, transcript = transcriber.transcribe(audio_url, config):json_file = open('transcript.json', 'w', encoding='utf8')
json_str = json.dumps(transcript.json_response, ensure_ascii=False, indent=2)
json_file.write(json_str)
json_file.close()
print(json_str)
In order to write data to a file, first import the fs package:If using the error handling code above then add this below it, otherwise add it after the transcript is created, const transcript = await client.transcripts.transcribe(params):const transcriptJSON = JSON.stringify(transcript, null, "\t");
fs.writeFile("transcript.json", transcriptJSON, (err) => {
if (err) throw err;
});
console.log(transcriptJSON);
How to Log the Transcript ID and Retrieve a Previously Created Transcript
To log the transcript ID for a transcription, after the transcript is created and below any error handling, add the following code:
To log the transcript ID for a transcription, after the transcript is created and below any error handling, add the following code:Use the following code to retrieve a previous transcript:transcript = aai.Transcript.get_by_id("<TRANSCRIPT_ID>")
print(transcript.text)
TranscriptGroup object:transcript_group = aai.TranscriptGroup.get_by_ids(["<TRANSCRIPT_ID_1>", "<TRANSCRIPT_ID_2>"])
for transcript in transcript_group:
print(transcript.text)
console.log("Transcript ID: ", transcript.id)
const allTranscriptsResponse = await fetch(
"https://api.assemblyai.com/v2/transcript?limit=4",
{
method: "GET",
headers: {
Authorization: "<YOUR_API_KEY>",
},
}
);
const allTranscripts = await allTranscriptsResponse.json();
console.log(allTranscripts);
const transcriptResponse = await fetch(
"https://api.assemblyai.com/v2/transcript/transcript_id",
{
method: "GET",
headers: {
Authorization: "<YOUR_API_KEY>",
},
}
);
const previousTranscript = await transcriptResponse.json();
console.log(previousTranscript);
transcript_id in the url with the ID of the transcript you are looking to fetch.
