/transcriptions

Last updated 4 months ago

Was this helpful?

Get transcription

get

Returns the specified transcription metadata.

Path parameters

transcriptionIdstringrequired

Transcription ID.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/transcriptions/{transcriptionId}'

200

401

404

429

{
  "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
  "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
  "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-01-01T00:01:00.000Z",
  "state": "ready",
  "durationInSeconds": 60,
  "type": "LIVE_TRANSCRIPTION",
  "filename": "room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd-2025-01-01T00:00:00.000Z.md",
  "storageType": "WHEREBY_HOSTED"
}

A JSON object representing the transcription.

Get transcription access link

get

Returns a URL that can be used to download the specified transcription. Available for Whereby-hosted transcriptions only.

Path parameters

transcriptionIdstringrequired

Transcription ID.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7

Query parameters

validForSecondsinteger · min: 1 · max: 43200 · default: 3600optional

The number of seconds the access link is valid for.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/transcriptions/{transcriptionId}/access-link'

200

401

403

404

429

{
  "accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
  "expires": 1740819600000
}

A JSON object representing the access link.

Delete transcription

delete

Deletes the specified transcription. The endpoint is idempotent, meaning it will return the same response even if the transcription has already been deleted.

Path parameters

transcriptionIdstringrequired

Transcription ID.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.whereby.dev/v1/transcriptions/{transcriptionId}'

204

401

429

No body

The resource was deleted successfully.

Get transcriptions

get

Returns a list of transcriptions

Query parameters

roomNamestringoptional

The name of the room

cursorstringoptional

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 50optional

The limit for the pagination - the maximum number of results that will be returned within a single API response.

sortByanyoptional

Sort results by a field. Accepted fields are: roomName, startDate and durationInSeconds. Accepted sort values are 'asc' and 'desc'.

Example: roomName:asc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/transcriptions'

200

401

429

{
  "results": [
    {
      "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-01T00:01:00.000Z",
      "state": "ready",
      "durationInSeconds": 60,
      "type": "LIVE_TRANSCRIPTION",
      "filename": "room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd-2025-01-01T00:00:00.000Z.md",
      "storageType": "WHEREBY_HOSTED"
    }
  ]
}

A JSON array representing the transcriptions.

Create transcription

post

Creates a new transcription for the specified recording.

Path parameters

recordingIdstringrequired

Recording ID.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Body

recordingIdstringrequired

The recording ID for which the transcription should be created.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/transcriptions' \
  --header 'Content-Type: application/json' \
  --data '{
    "recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a"
  }'

201

401

404

429

No body

The transcription job was scheduled successfully.

Bulk delete transcriptions

post

Deletes multiple transcriptions at once. This is an asynchronous operation. The endpoint returns immediately, and schedules a background job to delete the transcriptions. The endpoint is idempotent, meaning it will return the same response even if the transcriptions have already been deleted, or the transcriptions doesn't exist.

Body

transcriptionIdsstring[]required

The transcription ID to delete.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/transcriptions/bulk-delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "transcriptionIds": [
      "b438fda0-83e2-4835-92f9-c845ee3d5ea7"
    ]
  }'

204

401

429

No body

The resources are scheduled for deletion.