/transcriptions

Create transcription

Creates a new transcription for the specified recording.

post

/transcriptions

Path parameters

recordingIdanyrequired

Recording ID.

Example: 1

Body

recordingIdstringrequired

The recording ID for which the transcription should be created.

Example: 1

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/transcriptions' \
  --header 'Content-Type: application/json' \
  --data '{"recordingId":"1"}'

201

401

404

429

201

No body

The transcription job was scheduled successfully.

Get transcriptions

Returns a list of transcriptions

get

/transcriptions

Query parameters

roomNamestring

The name of the room

cursorstring

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: 50

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

sortByany

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

429

200

{
  "results": [
    {
      "transcriptionId": "1",
      "roomSessionId": "1",
      "filename": "transcription.md",
      "roomName": "room-name",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "state": "ready",
      "type": "LIVE_TRANSCRIPTION",
      "createdAt": "2020-01-01T00:00:00.000Z"
    }
  ]
}

A JSON array representing the transcriptions.

Get transcription

Returns the specified transcription metadata.

get

/transcriptions/{transcriptionId}

Path parameters

transcriptionIdanyrequired

Transcription ID.

Example: 1

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

404

429

200

{
  "transcriptionId": "1",
  "roomSessionId": "1",
  "filename": "transcription.md",
  "roomName": "room-name",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "state": "ready",
  "type": "LIVE_TRANSCRIPTION",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

A JSON object representing the transcription.

Get transcription access link

Returns the access link for the specified transcription.

get

/transcriptions/{transcriptionId}/access-link

Path parameters

transcriptionIdanyrequired

Transcription ID.

Example: 1

Query parameters

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

The number of seconds the access link is valid for.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

404

429

200

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

A JSON object representing the access link.

Bulk delete transcriptions

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.

post

/transcriptions/bulk-delete

Body

transcriptionIdsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/transcriptions/bulk-delete' \
  --header 'Content-Type: application/json' \
  --data '{"transcriptionIds":["1"]}'

204

401

429

204

No body

The resources are scheduled for deletion.

Delete transcription

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

delete

/transcriptions/{transcriptionId}

Path parameters

transcriptionIdanyrequired

Transcription ID.

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

204

401

429

204

No body

The resource was deleted successfully.