For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
PlaygroundChangelogSign In
OverviewAPI ReferencePre-recorded STTStreaming STTVoice AgentsSpeech UnderstandingGuardrailsLLM GatewayFAQ
OverviewAPI ReferencePre-recorded STTStreaming STTVoice AgentsSpeech UnderstandingGuardrailsLLM GatewayFAQ
  • Getting started
    • Overview
    • Build with AI coding agents
    • Models
    • Evaluate model accuracy
    • Manage your account
    • Introducing Universal-3 Pro
    • End-to-end examples
  • Use cases & integrations
    • Use case guides
    • Integrations
      • AI coding agents
        • Zapier
        • Make
        • n8n
        • Postman
  • Trust & security
    • Trust center
    • Security overview
    • Data retention and model training
LogoLogo
PlaygroundChangelogSign In
On this page
  • Quickstart
Use cases & integrationsIntegrationsNo-code tools

The Postman collection for the AssemblyAI API

Was this page helpful?
Built with

Postman is a user-friendly tool for testing API endpoints. The AssemblyAI API Postman collection contains all the HTTP requests you can make to the AssemblyAI API, so you don’t need to write them yourself.

AssemblyAI API Postman collection

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.

Click Fork on the AssemblyAI API collection

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.

Configure AssemblyAI API key in Postman collection

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

Send upload audio file to AssemblYAI API HTTP request

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

The response for uploading an audio file to AssemblYAI API

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

Create a transcript HTTP request

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

Create a transcript HTTP response

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 goes from queued to processing to completed. 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

Get a transcript HTTP request and response

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)