/transcriptions

Create transcription

Creates a new transcription for the specified recording.

POSThttps://api.whereby.dev/v1/transcriptions

Path parameters

recordingId*any

Recording ID.

Example: "1"

Body

application/json

recordingId*string

The recording ID for which the transcription should be created.

Example: "1"

Response

201401404429

The transcription job was scheduled successfully.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recordingId": "1"
    }),
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

Get transcriptions

Returns a list of transcriptions

GEThttps://api.whereby.dev/v1/transcriptions

Query parameters

Response

200401429

A JSON array representing the transcriptions.

Body

application/json

results*array of Transcription (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "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": "completed",
      "createdAt": "2020-01-01T00:00:00.000Z"
    }
  ]
}

Get transcription

Returns the specified transcription metadata.

GEThttps://api.whereby.dev/v1/transcriptions/{transcriptionId}

Path parameters

transcriptionId*any

Transcription ID.

Example: "1"

Response

200401404429

A JSON object representing the transcription.

Body

application/json

transcriptionId*string

The ID of the transcription.

roomSessionId*string

The ID of the room session.

filename*string

The filename of the transcription.

roomName*string

The name of the room.

startDate*string (date-time)

When the transcription starts. Always in UTC, regardless of the input timezone.

endDate*string (date-time)

When the transcription ends. Always in UTC, regardless of the input timezone.

state*enum

The state of the transcription

• ready - The transcription is ready to be downloaded
• failed - The transcription failed to be generated
• in_progress - The transcription is still being generated

readyfailedin_progress

createdAt*string (date-time)

When the transcription was created. Always in UTC, regardless of the input timezone.

type*enum

The type of the transcription

• RECORDING_TRANSCRIPTION - Session Transcription
• RECORDING_TRANSCRIPTION - generated based on a recording

RECORDING_TRANSCRIPTIONRECORDING_TRANSCRIPTION

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "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": "completed",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

Get transcription access link

Returns the access link for the specified transcription.

GEThttps://api.whereby.dev/v1/transcriptions/{transcriptionId}/access-link

Path parameters

transcriptionId*any

Transcription ID.

Example: "1"

Query parameters

Response

200401404429

A JSON object representing the access link.

Body

application/json

accessLink*string

The access link.

Example: "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ..."

expires*integer

The timestamp when the access link expires.

Example: 1588262400000

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}/access-link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

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

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.

DELETEhttps://api.whereby.dev/v1/transcriptions/{transcriptionId}

Path parameters

transcriptionId*any

Transcription ID.

Example: "1"

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

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.

POSThttps://api.whereby.dev/v1/transcriptions/bulk-delete

Body

application/json

transcriptionIds*array of string

Response

204401429

The resources are scheduled for deletion.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/transcriptions/bulk-delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transcriptionIds": [
        "1"
      ]
    }),
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}