> ## 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.

# The Postman collection for the AssemblyAI API

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.

<Card icon="signs-post" title="AssemblyAI API Postman collection" href="https://assembly.ai/postman" />

## Quickstart

<Steps>
  <Step>
    Open the [AssemblyAI API collection](https://assembly.ai/postman) in Postman and click the **Fork** button. This will create a copy of the collection that you can edit.

    <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/1-fork-collection.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=f9b2ea292617abd8405dc0d18199bb17" alt="Click Fork on the AssemblyAI API collection" width="2184" height="934" data-path="assets/img/integrations/postman/1-fork-collection.png" />

    Fill out the form and click **Fork Collection**.
  </Step>

  <Step>
    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](https://www.assemblyai.com/dashboard/home).

    <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/2-configure-variables.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=a487662eaa3ec7869d6986c34633d24e" alt="Configure AssemblyAI API key in Postman collection" width="1554" height="712" data-path="assets/img/integrations/postman/2-configure-variables.png" />
  </Step>

  <Step>
    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](https://assembly.ai/nbc.mp3)
    5. Click the **Send** button

           <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/3-upload-file-request.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=13c34c815da5576bcb10da3200078985" alt="Send upload audio file to AssemblYAI API HTTP request" width="1514" height="518" data-path="assets/img/integrations/postman/3-upload-file-request.png" />

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

    <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/4-upload-file-response.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=8d4b730b6382671edcc39412547f9263" alt="The response for uploading an audio file to AssemblYAI API" width="1552" height="382" data-path="assets/img/integrations/postman/4-upload-file-response.png" />
  </Step>

  <Step>
    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

           <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/5-create-transcript-request.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=3f457cb58984c93d1db5183904781b05" alt="Create a transcript HTTP request" width="1552" height="476" data-path="assets/img/integrations/postman/5-create-transcript-request.png" />

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

    <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/6-create-transcript-response.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=4c06f90f9880d212453a5dcad4772d43" alt="Create a transcript HTTP response" width="1536" height="532" data-path="assets/img/integrations/postman/6-create-transcript-response.png" />
  </Step>

  <Step>
    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 rate 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

           <img src="https://mintcdn.com/assemblyai-fff14a6f/QiQdgq4Y8it2UHbH/assets/img/integrations/postman/7-get-transcript.png?fit=max&auto=format&n=QiQdgq4Y8it2UHbH&q=85&s=56dab64eb71805d456fea9edc1226406" alt="Get a transcript HTTP request and response" width="1552" height="1400" data-path="assets/img/integrations/postman/7-get-transcript.png" />

    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`.
  </Step>

  <Step>
    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)
  </Step>
</Steps>
