Initiate a Transcription

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

Transcribe recording

Create transcription for a recording

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

Authorization

useraccessKey

Path parameters

workspaceId*string

recordingId*string

Body

application/json

locale*SupportedLocales (enum)

Example: "en-US"

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

messageIdstring (uuid)

conversationIdstring (uuid)

recordingIdstring (uuid)

Response

202400404422

Transcription was accepted for processing

Body

application/json

id*Transcription ID

The ID for the transcription.

recordingId*Recording ID

The ID for the recording.

status*TranscriptionStatus (enum)

acceptedongoingavailableabsentfailed

stereo*boolean

locale*SupportedLocales (enum)

Example: "en-US"

ar-AEar-SAcmn-CNcy-GBda-DKde-CHde-DEel-GRen-AUen-GBen-GB-WLSen-IEen-INen-NZen-USen-ZAes-ESes-MXes-USfr-CAfr-FRhe-ILhi-INid-IDis-ISit-ITja-JPko-KRms-MYnb-NOnl-NLpl-PLpt-BRpt-PTro-ROru-RUsv-SEta-INte-INth-THtr-TRvi-VNzh-CNzh-HKzh-TWarbaf-ZAbn-INca-EScmn-TWcs-CZfi-FIfil-PHgu-INhu-HUkn-INlt-LTlv-LVml-INmr-INpa-INsk-SKsr-RSuk-UAyue-HKno-NO

urlstring

summarystring

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/recordings/{recordingId}/transcriptions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "locale": "en-US"
    }),
});
const data = await response.json();

Response

202400404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "recordingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "stereo": false,
  "locale": "en-US",
  "url": "text",
  "summary": "text",
  "createdAt": "2024-12-21T12:16:42.045Z",
  "updatedAt": "2024-12-21T12:16:42.045Z"
}

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.

Request

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

Response

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