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

post

Create transcription for a recording

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstringRequired

recordingIdstringRequired

Body

application/json

localestring · enumRequiredDefault: en-USExample: en-USPossible values:

messageIdstring · uuidOptional

conversationIdstring · uuidOptional

recordingIdstring · uuidOptional

Responses

202

Transcription was accepted for processing

application/json

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/recordings/{recordingId}/transcriptions HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "locale": "en-US",
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "conversationId": "123e4567-e89b-12d3-a456-426614174000",
  "recordingId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "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-12-27T10:27:43.013Z",
  "updatedAt": "2025-12-27T10:27:43.013Z"
}

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: AccessKey YOUR_SECRET_TOKEN'

Response