Get one transcript

This endpoint enables you to retrieve the transcription for a specific meeting.

Before we start

To utilize this endpoint, you should have a meetingId that corresponds to the meeting you intend to reference.

Additionally, it's crucial to activate transcription during the meeting. This can be achieved by either clicking the toolbar at the bottom of the interface or by invoking the toggleTranscript() 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://nodeapi.superviz.com/transcript?meetingId=<MEETING_ID> \
	--header  "Authorization: Bearer ${TOKEN}" \

HTTP Request

GET https://nodeapi.superviz.com/transcript?meetingId=<MEETING_ID>

Headers

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

Name	Description
Authorization	Required. You must utilize the authentication token.
apikey	Required. The passphrase of your organization that allows the decryption of the transcript content, which you can obtain by using the security keys endpoint.

Queries

In the query of this request, send the following field:

Name	Description
meetingId	Required. This field should contain the unique identification of the meeting during which transcription should be activated.

Response

Successful request

Status code 200 will indicate that the request was successful. The response will be in JSON format and include the following fields:

Name	Type	Description
meetingId	string	The unique identification of the meeting.
transcript	array	An array of objects containing the transcription details.
transcript[].date	string	The timestamp of the transcription.
transcript[].participant	string	The unique identification of the participant.
transcript[].content	string	The spoken content of the participant.

Example:

{
  "meetingId": "your-meeting-id",
  "transcript": [
    {
      "date": "1712232456590",
      "participant": "participant-id",
      "content": "spoken content"
    },
    ...
  ]
}

Invalid request

When the API encounters an invalid request, it will respond with the following information:

Name	Type	Description
statusCode	number	The HTTP Status Code.
error	string	The HTTP Status name provides information on the error type.
message	string	An explanation of the error and actionable steps to resolve it.

Example:

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Invalid API Key"
}