DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Initiate a Transcription

In order to initiate a transcription for an existing recording, you must do a POST request to the following endpoint.
POST
/workspaces/{workspaceId}/recordings/{recordingId}/transcriptions
Create transcription for a recording
Payload della richiesta
locale
string
obbligatorio
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: 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
messageId
string
conversationId
string
recordingId
string
Payload della risposta
id
string
obbligatorio
The ID for the transcription.
recordingId
string
obbligatorio
The ID for the recording.
status
string
obbligatorio
Possible values: accepted, ongoing, available, absent, failed
stereo
boolean
obbligatorio
locale
string
obbligatorio
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: 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
url
string
summary
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/recordings/{recordingId}/transcriptions' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
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.
Esempio di codice
curl "/workspaces/{workspaceId}/recordings/{recordId}/transcriptions" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'