DocumentationEngagement Platform API
Sign inGet started
Guides
API

List Transcriptions

In order to retrieve all transcriptions in your workspace you can use this request.
GET
/workspaces/{workspaceId}/transcriptions
List transcriptions
Paramètres de requête
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.id
string
obligatoire
The ID for the transcription.
results.recordingId
string
obligatoire
The ID for the recording.
results.status
string
obligatoire
Possible values: accepted, ongoing, available, absent, failed
results.stereo
boolean
obligatoire
results.locale
string
obligatoire
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
results.url
string
results.summary
string
results.createdAt
string
obligatoire
results.updatedAt
string
obligatoire
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/transcriptions' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
Exemple de code
curl "/workspaces/{workpaceId}/transcriptions" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'