Skip to main content

Get recordings with transcription

This endpoint enables you to get a list of the recordings in which the transcription is already available.

To make a transcription available, you must generate it using the post transcript endpoint and it may take up to 20 minutes to be available.

To get the transcript of a specific recording you'll need to use the get transcript endpoint.

Before we start​

Transcripts must be generated upon request. If you have already generated a transcript, you can use the recordingId to get the transcript.

You are only able to get the transcript of a recording of a meeting. To record a meeting, you must enable the recording feature during the meeting. It can be achieved by either clicking the toolbar button 'Record' at the interface or by invoking the toogleRecording() method on the Video Conference.

How to use​

You can use the following cURL to obtain a response on the endpoint:

curl --location --request GET https://api.superviz.com/recording/with-transcripts \
  --header 'Content-Type: application/json' \
  --header "client_id: ${YOUR CLIENT_ID}" \
  --header "secret: ${YOUR SECRET}" \
  --header "passphrase: ${YOUR PASSPHRASE}"

HTTP Request​

GET https://api.superviz.com/recording/with-transcripts?roomId={ROOM_ID}&meetingId={MEETING_ID}

You can filter the recordings by the roomId or the meetingId.

NameDescription
roomIdWhen providing the roomId, it will return all the recordings made in the room.
meetingIdWhen providing the meetingId, it will return the recordings made in a specific meeting.

Headers​

When using this endpoint, you need to provide the Authorization Bearer token and the passphrase. The following headers are required:

NameDescription
client_idRequired. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secretRequired. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Response​

Status code 200 will indicate that the request was successful. The response will be a list of recordings in JSON format with our pagination schema and include the following fields:

NameTypeDescription
uuidstringThis field contains the unique identification of the recording.
urlstringThis field contains a temporary URL where the recording is stored and can be used to download or visualize it. We do not recommend saving this information on your end since the URL can expire.
roomIdstringThis field contains the unique identification of the room during which the recording was made.
statusstringThis field contains the status of the recording. The possible values are processing and available. The URL of the recording will be available after about 5 minutes of the end of the recording.
meetingIdstringThis field contains the unique identification of the meeting during which the recording was made. Remember that one meeting can contain multiple recordings.
createdAtstringThis field contains the date and time when the recording was created.

Example:

[
  {
    uuid: "RECORDING_ID",
    url: "https://.../",
    roomId: "ROOM_ID",
    status: "processing",
    meetingId: "MEETING_ID",
    createdAt: "2024-05-13T17:14:00.941Z",
  },
];