Get topics from a transcript

This endpoint enables you to use AI queries to return meeting summaries, providing valuable insights from your meetings.

Stay tuned for future updates as we expand to offer more features, including topics, action items, sentiments, and more.

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 POST https://nodeapi.superviz.com/transcript/topic \
	--header 'Content-Type: application/json' \
	--header  "Authorization: Bearer ${YOUR TOKEN}" \
	--header "passphrase: ${YOUR PASSPHRASE}" \
	--data-raw ' {
		"meetingId": "<MEETING_ID>",
		"subject": "summary"
	} '

HTTP Request

POST https://nodeapi.superviz.com/transcript/topic

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.

Request Body

When sending a request, include the following fields in JSON format:

Name	Type	Description
meetingId	string	Required. This field should contain the unique identification of the meeting during which transcription should be activated.
subject	TranscriptSubjects	Required. Use this field to specify the specific content or context you want the AI to work on within the meeting transcription.

Example:

{
	"meetingId": "<METTING_ID>",
	"subject": "summary"
}

Response Body

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
content	string	The response content for the AI Transcript request.

Example:

{
	"content": "Every Sunday morning, Mona and her husband Jack go to their favorite restaurant for breakfast. They always go at the same time and sit at the same table. They usually order the same dishes, but one Sunday Jack surprises Mona by asking for a fried egg instead of his usual scrambled eggs. The waiter is confused, but Jack insists on having a fried egg. Since then, Jack always asks for fried eggs for breakfast."
}

Invalid Request

When the API encounters an invalid request, it will provide a response 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": "Please type on your subject:summary",
}

Types Definition

TranscriptSubjects

This type defines the available options for specifying the desired content within the meeting transcription.

Type: enum

• summary: Request the API to generate a summary for the meeting.