v3

latestOpenAPI 3.1.02026-08-011057254.3 KB
transcript

List transcripts

<Note>To retrieve your transcriptions on our EU server, replace api.assemblyai.com with api.eu.assemblyai.com.</Note> Retrieve a list of transcripts you created. Transcripts are sorted from newest to oldest and can be retrieved for the last 90 days of usage. The previous URL always points to a page with older transcripts.

If you need to retrieve transcripts from more than 90 days ago please reach out to our Support team at support@assemblyai.com.

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/v2/transcript

Query parameters

limitinteger

Maximum amount of transcripts to retrieve

status'queued' | 'processing' | 'completed' | 'error'

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

Filter by transcript status

created_onstring date

Only get transcripts created on this date

before_idstring uuid

Get transcripts that were created before this transcript ID

after_idstring uuid

Get transcripts that were created after this transcript ID

throttled_onlyboolean

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.

Example response

{
  "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
    }
  ]
}