import os

from assemblyai import ListTranscriptParameters
from assemblyai.prerecorded.v2 import Transcriber

transcriber = Transcriber(api_key=os.environ["ASSEMBLYAI_API_KEY"])

page = transcriber.list_transcripts(
    ListTranscriptParameters(limit=5, status="completed")
)

for item in page.transcripts:
    print(item.id, item.status)

{
  "page_details": {
    "limit": 3,
    "result_count": 3,
    "current_url": "https://api.assemblyai.com/v2/transcript?limit=3",
    "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117",
    "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229"
  },
  "transcripts": [
    {
      "id": "b33f4691-85b7-4f31-be12-a87cef1c1229",
      "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229",
      "status": "completed",
      "created": "2024-03-11T21:29:59.936851",
      "completed": "2024-03-11T21:30:07.314223",
      "audio_url": "http://deleted_by_user",
      "error": null
    },
    {
      "id": "ce522f10-d204-42e8-a838-6b95098145cc",
      "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc",
      "status": "error",
      "created": "2024-03-11T21:23:59.979420",
      "completed": null,
      "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.oopsie",
      "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.oopsie. Please make sure the file exists and is accessible from the internet."
    },
    {
      "id": "28a73d01-98db-41dd-9e98-2533ba0af117",
      "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117",
      "status": "completed",
      "created": "2024-03-11T21:12:57.372215",
      "completed": "2024-03-11T21:13:03.267020",
      "audio_url": "https://assembly.ai/nbc.mp3",
      "error": null
    }
  ]
}

{
  "error": "This is a sample error message"
}

{
  "error": "Authentication error, API token missing/invalid"
}

{
  "error": "Not found"
}

{
  "error": "Too Many Requests"
}

{
  "error": "Internal server error. Please retry your request. If the error persists, please contact support@assemblyai.com for more information."
}

API reference

List transcripts

To retrieve your transcriptions on our EU server, replace api.assemblyai.com with api.eu.assemblyai.com.

Retrieve a list of transcripts you created. Transcripts are sorted from newest to oldest and can be retrieved for the last 30 days of usage. The previous URL always points to a page with older transcripts.

Pagination

This endpoint returns paginated results. The response includes a page_details object with the following properties:

page_details.limit - Maximum number of transcripts per page.
page_details.result_count - Total number of transcripts returned on the current page.
page_details.current_url - URL to the current page.
page_details.prev_url - URL to the previous page of older transcripts.
page_details.next_url - URL to the next page of newer transcripts.

GET

transcript

import os

from assemblyai import ListTranscriptParameters
from assemblyai.prerecorded.v2 import Transcriber

transcriber = Transcriber(api_key=os.environ["ASSEMBLYAI_API_KEY"])

page = transcriber.list_transcripts(
    ListTranscriptParameters(limit=5, status="completed")
)

for item in page.transcripts:
    print(item.id, item.status)

{
  "page_details": {
    "limit": 3,
    "result_count": 3,
    "current_url": "https://api.assemblyai.com/v2/transcript?limit=3",
    "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117",
    "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229"
  },
  "transcripts": [
    {
      "id": "b33f4691-85b7-4f31-be12-a87cef1c1229",
      "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229",
      "status": "completed",
      "created": "2024-03-11T21:29:59.936851",
      "completed": "2024-03-11T21:30:07.314223",
      "audio_url": "http://deleted_by_user",
      "error": null
    },
    {
      "id": "ce522f10-d204-42e8-a838-6b95098145cc",
      "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc",
      "status": "error",
      "created": "2024-03-11T21:23:59.979420",
      "completed": null,
      "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.oopsie",
      "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.oopsie. Please make sure the file exists and is accessible from the internet."
    },
    {
      "id": "28a73d01-98db-41dd-9e98-2533ba0af117",
      "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117",
      "status": "completed",
      "created": "2024-03-11T21:12:57.372215",
      "completed": "2024-03-11T21:13:03.267020",
      "audio_url": "https://assembly.ai/nbc.mp3",
      "error": null
    }
  ]
}

{
  "error": "This is a sample error message"
}

{
  "error": "Authentication error, API token missing/invalid"
}

{
  "error": "Not found"
}

{
  "error": "Too Many Requests"
}

{
  "error": "Internal server error. Please retry your request. If the error persists, please contact support@assemblyai.com for more information."
}

Authorizations

Authorization

string

header

required

Add your AssemblyAI API key as the Authorization header value. Required on every request.

Query Parameters

limit

integer

default:10

Maximum amount of transcripts to retrieve

Required range: 1 <= x <= 200

status

enum<string>

Filter by transcript status The status of your transcript. Possible values are queued, processing, completed, or error.

Available options:

queued,

processing,

completed,

error

created_on

string<date>

Only get transcripts created on this date

before_id

string<uuid>

Get transcripts that were created before this transcript ID

after_id

string<uuid>

Get transcripts that were created after this transcript ID

throttled_only

boolean

default:false

Only get throttled transcripts, overrides the status filter

Response

A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.

page_details

object

required

Details of the transcript page

Show child attributes

Example:

{
  "limit": 10,
  "result_count": 10,
  "current_url": "https://api.assemblyai.com/v2/transcript?limit=10",
  "prev_url": "https://api.assemblyai.com/v2/transcript?limit=10&before_id=62npeahu2b-a8ea-4112-854c-69542c20d90c",
  "next_url": "https://api.assemblyai.com/v2/transcript?limit=10&after_id=62nfw3mlar-01ad-4631-92f6-629929496eed"
}

transcripts

object[]

required

An array of transcripts

Show child attributes

Getting started

Features

API reference

Advanced

Guides

List transcripts

Authorizations

Query Parameters

Response