Initiate a Transcription

In order to initiate a transcription for an existing recording, you must do a POST request to the following endpoint.

A transcription request is asynchronous. That means it will take some time before the result has been generated. This depends on the total duration of the recording.

curl "/workspaces/{workspaceId}/recordings/{recordId}/transcriptions" \
     -H 'Authorization: Bearer {Token}'

{
  "id": "85530fbe-6dc1-4884-a9e6-e62b0f4c6df1",
  "recordingId": "5b74ee9e-9d45-473a-82cd-f1f7feea6bbd",
  "status": "accepted",
  "stereo": false,
  "locale": "en-US",
  "createdAt": "2023-10-24T12:52:27.483Z",
  "updatedAt": "2023-10-24T12:52:27.483Z"
}

Last updated 6 months ago

Was this helpful?

Transcribe recording

Create transcription for a recording

post

/workspaces/{workspaceId}/recordings/{recordingId}/transcriptions

Authorizations

Path parameters

workspaceIdstringrequired

recordingIdstringrequired

Body

localestring · enum · default: en-USrequired

Example: en-US

Options: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO

messageIdstring · uuid

conversationIdstring · uuid

recordingIdstring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/recordings/{recordingId}/transcriptions' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "locale": "en-US",
    "messageId": "123e4567-e89b-12d3-a456-426614174000",
    "conversationId": "123e4567-e89b-12d3-a456-426614174000",
    "recordingId": "123e4567-e89b-12d3-a456-426614174000"
  }'

202

400

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "recordingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "stereo": true,
  "locale": "en-US",
  "url": "text",
  "summary": "text",
  "createdAt": "2025-02-28T07:00:55.611Z",
  "updatedAt": "2025-02-28T07:00:55.611Z"
}

Transcription was accepted for processing