The Postman collection for the AssemblyAI API

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.

​

Quickstart

1

Open the AssemblyAI API collection in Postman and click the Fork button. This will create a copy of the collection that you can edit.Fill out the form and click Fork Collection.

2

Next, click on the Variables tab and configure the apiKey variable with your AssemblyAI API key. You can find your AssemblyAI API key in the AssemblyAI dashboard.

3

Let’s upload an audio file:

1. Open the Files > Upload a media file request
2. Switch to the Body tab
3. Change the dropdown from none to binary
4. Select an audio file of your choosing, or download this sample audio file
5. Click the Send button

Inspect the Body of the response and copy the upload_url value.

4

Now that the audio file is uploaded, you can transcribe the audio file.

1. Open the Transcripts > Transcribe audio request
2. Switch to the Body tab
3. Find the audio_url property and update it to the upload_url value from the previous request.
4. Remove all the other properties. Optionally, you can leave any property that you do want to use.
5. Click the Send button

Inspect the Body of the response and copy the id value.

5

The transcription job will take longer depending on the duration of the file. You need to check the status property to check if a transcript is ready. The status typically goes from processing to completed. The status can also be queued if the job is waiting to be processed (for example, when you’ve exceeded your concurrency limit), in which case it will move to processing once a slot is available. The status can also become error at any point. If an error occurs, you can find the error message under the error property.

1. Open the Transcripts > Get transcript request
2. Find the transcript_id under Path variables and update the value with the id value from the previous request.
3. Remove all the other properties. Optionally, you can leave any property that you do want to use.
4. Click the Send button

Inspect the Body of the response to check if the status is completed or error. If not, resend the request until it is completed or error.

6

Now that you have a completed transcript, you can send these other HTTP requests with your current transcript ID:

• Transcripts
  • Get subtitles for transcript
  • Get sentences in transcript
  • Get paragraphs in transcript
  • Search words in transcript
  • Get redacted audio (if PII audio redaction is enabled)