Get a Transcription

In order to retrieve a transcription metada, you can use the following endpoint.

Get transcription

Get transcription

GET/workspaces/{workspaceId}/transcriptions/{transcriptionId}

Authorization

useraccessKey

Path parameters

workspaceId*string

transcriptionId*string

Query parameters

Response

200307404422

The transcription metadata

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)

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

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/transcriptions/{transcriptionId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "recordingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "stereo": false,
  "locale": [
    "en-US"
  ],
  "url": "text",
  "createdAt": "2024-04-29T11:33:09.517Z",
  "updatedAt": "2024-04-29T11:33:09.517Z"
}

Request

curl "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/transcriptions/7f1e9ce1-95db-4a39-80f4-9bde69908c53" \
     -H 'Authorization: Bearer {Token}'

Response

{
  "id": "7f1e9ce1-95db-4a39-80f4-9bde69908c53",
  "recordingId": "5b74ee9e-9d45-473a-82cd-f1f7feea6bbd",
  "status": "available",
  "stereo": false,
  "locale": "en-US",
  "url": "https://regional--voice-recordings--637323691990--euw1.s3.eu-west-1.amazonaws.com/workspaceID%218bc02f53-87ac-48d2-b4fd-c2cf856a305f/sourceID%2150fa2203-66c2-4820-864a-1a8002952f4e/7f1e9ce1-95db-4a39-80f4-9bde69908c53.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZIY3TY7LBTBZCS45%2F20231024%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20231024T130534Z&X-Amz-Expires=600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBwaCWV1LXdlc3QtMSJHMEUCIBch4MlGQu3ErdIzwknxkM0z23Clo79heSynPWNzU7jeAiEA%2F9fuYlS5yImmZ%2FN53KEmG2dEENZFbPfoNkrdPj%2BExHMq7QMIRRABGgw2MzczMjM2OTE5OTAiDCSO0vsLR5UJ%2BOYdrirKAzCu4U7saMI%2FVJDauiWwesWmbhSYCt1LdcULqH4AqrKk1I700LcFzBTQ1HPjfbLDyM169KlHgY%2Fdw51lvvRt7vqynvho2Vwk6CQoNYNk2%2FORr07phUNtKZgxi%2FbD5cgvRz2upRixYdqST7CoDdN1QsSEz43jS9ka5vGHKZV3OvBXmCKElk9QU5557xIppybAbcQ6sCXssfEkcKsLpKaiLN8nN%2FRGJ6kyWriih41NaoNRv6ykPiqpQJtAIvEtRx19iY98vj%2Bg06TMKuzBXp%2FcLXI3KlUpVTBZRYetCNC7Kf5lpg2amyK9FNW14OPc9hArFkG%2F%2Fah7bj0KJJaink3Lu1m2A61DhkiQeqnUeY5tGTgh4vdEZT20%2BiNwMWI7UGErcesbcqQJnCm3oTwbbalsOIDfiPcYt1dKvjW0FJeclFY935sAIJiARlcCud%2BcNf96LtUc%2Bp3cMI1jTzbXec4YK%2BXMjYUczTpQ%2F%2BvHEeNdJkv9af%2B3hwMineFvtcW3e3r7dfmFYD5moZh91Ykj2N35RQ7Vvyvnb%2B4tax43j%2BUpOjth9sMZHo3bjgGpkYVc1mBOGtrSrQPANyQXKCIIS6YIOvFegGCeCU5ntkFnMJLe3qkGOqUBJRIHI%2BL5lnQl6U0i1YtFD9GI8B9O6M%2FLfdOkZLG7FWX0cpCoQtDVCKxQya5tQclGr5DasMadT5CWRQQTxgiCkQNxZLV%2FsnUVxPuVW%2Bxw9%2BnPZ%2BKzkSJ3zacSVhby2AUeZCMc5AkboJX0a4%2FnJ5%2FhULZtruZF0cwGHl69nCLTT1OLrj3%2FarCgYkyaRZyjlaz4zNulyBGqy%2BPkDP8xVKRPEGotlBHf&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=f4f9aa1ffaf2653b4b2ba9aa7fc786a3f74f0c662d9bee1aa5077587d63b70b6",
  "createdAt": "2023-10-23T15:55:38.888Z",
  "updatedAt": "2023-10-23T15:55:47.439Z"
}

To get the transcription content you use the endpoint for your preferred format:

• GET /workspaces/{workspaceId}/transcriptions/{transcriptionId}.json

• GET /workspaces/{workspaceId}/transcriptions/{transcriptionId}.srt

• GET /workspaces/{workspaceId}/transcriptions/{transcriptionId}.vtt

• GET /workspaces/{workspaceId}/transcriptions/{transcriptionId}.txt