Cookies 🍪

This site uses cookies that need consent. Learn More

Hyperia
Back to hyperia.net

Connecting to Online Meetings

Overview

Hyperia provides a programmable AI Notetaker that can be directed to join any Zoom, Google Meet, or Microsoft Teams meeting and live-stream audio for analysis, transcription, and NLP enrichment.

Join an Online Meeting

Directs the Hyperia AI Notetaker to join an online meeting (Google Meet, Teams, Zoom) for capture and transcription.

Endpoint:

/v1/meeting/join

HTTP Method:

PUT

URI Parameters:

None

JSON PUT Payload Format:

Name Description
meeting_link Link to join the online meeting (Google Meet, Zoom, Teams)
password (optional) Password to join the online meeting
index_data (optional) Whether to index the meeting (enabled by default)
live_stream (optional) Whether to create a live analysis websocket stream for the meeting (disabled by default)

Returns:

If successful: HTTP 200

Return Payload:

RESPONSE 
{
    "status", "ok",
    "result": {
        "meeting_id": "GUID_OF_MEETING",
        "start_time_utc": "YYYY-MM-DDTHH:MM:SS",
        "duration_minutes": MIN_MEETING_MINUTES,
		"hard_stop": true | false,
        "meeting_data": {
            "meeting_id": "ID_OF_MEETING",
            "meeting_password": "PASSWORD_OF_MEETING",
            "meeting_link": "WEB_LINK_FOR_MEETING",
            "meeting_type": "zoom | microsoft_teams | google_meet"
        },
		"stream_data": {
		    "event_socket": "WEBSOCKET_URI_IF_LIVESTREAMING_IS_ACTIVE"
		},
        "notetaker_name": "NAME_OF_NOTETAKER",
		"status": "MEETING_STATUS",
        "notetaker_status": {
		  "description": "STATUS_DESCRIPTION",
		  "state": INTEGER_STATE_VALUE
		}
    }
}

Code Sample:

from hyperia import Hyperia
import sys

meeting_link = "SOME_MEETING_LINK"
meeting_password = "OPTIONAL_MEETING_PASSWORD"

hyperia = Hyperia()

response = hyperia.meeting_join(meeting_link,
							    meeting_password)

if not response:
  	sys.exit(-1)

// success

List Meetings

Lists any meetings currently being attended by the Hyperia AI Notetaker.

Endpoint:

/v1/meeting/list

HTTP Method:

GET

URI Parameters:

None

Returns:

If successful: HTTP 200

Return Payload:

RESPONSE 
{
    "status", "ok",
    "results": [
	  {
        "meeting_guid": "GUID_OF_MEETING",
        "start_time_utc": "YYYY-MM-DDTHH:MM:SS",
        "duration_minutes": MIN_MEETING_MINUTES,
		"hard_stop": true | false,
        "meeting_data": {
            "meeting_id": "ID_OF_MEETING",
            "meeting_password": "PASSWORD_OF_MEETING",
            "meeting_link": "WEB_LINK_FOR_MEETING",
            "meeting_type": "zoom | microsoft_teams | google_meet"
        },
		"stream_data": {
		    "event_socket": "WEBSOCKET_URI_IF_LIVESTREAMING_IS_ACTIVE"
		},
        "notetaker_name": "NAME_OF_NOTETAKER",
        "notetaker_status": "spawned",
	  }
    }
}

Code Sample:

from hyperia import Hyperia
import sys

hyperia = Hyperia()

response = hyperia.meeting_list()

if not response:
  	sys.exit(-1)

// success

Get Meeting Info

Retrieves information on an active meeting currently being attended by the Hyperia AI Notetaker using a meeting ID.

Endpoint:

/v1/meeting/id/<meeting_id>/metadata/info

HTTP Method:

GET

URI Parameters:

Name Description
meeting_id ID of the meeting to retrieve info for.

Returns:

If successful: HTTP 200

Return Payload:

RESPONSE 
{
    "status", "ok",
    "result": {
        "meeting_guid": "GUID_OF_MEETING",
        "start_time_utc": "YYYY-MM-DDTHH:MM:SS",
        "duration_minutes": MIN_MEETING_MINUTES,
		"hard_stop": true | false,
        "meeting_data": {
            "meeting_id": "ID_OF_MEETING",
            "meeting_password": "PASSWORD_OF_MEETING",
            "meeting_link": "WEB_LINK_FOR_MEETING",
            "meeting_type": "zoom | microsoft_teams | google_meet"
        },
		"stream_data": {
		    "event_socket": "WEBSOCKET_URI_IF_LIVESTREAMING_IS_ACTIVE"
		},
        "notetaker_name": "NAME_OF_NOTETAKER",
        "notetaker_status": "spawned",
	}
}

Code Sample:

from hyperia import Hyperia
import sys

meeting_id = "SOME_MEETING_ID"

hyperia = Hyperia()

response = hyperia.meeting_info(meeting_id)

if not response:
  	sys.exit(-1)

// success

Check for Meeting Existence

Checks to see if an active meeting (Hyperia Notetaker session) exists using the specified meeting ID.

Endpoint:

/v1/meeting/id/<meeting_id>/exists

HTTP Method:

GET

URI Parameters:

Name Description
meeting_id ID of the meeting to retrieve info for.

Returns:

If successful: HTTP 200

Return Payload:

RESPONSE 
{
    "status": "ok",
	"exists": true | false
}

Code Sample:

from hyperia import Hyperia
import sys

meeting_id = "SOME_MEETING_ID"

hyperia = Hyperia()

response = hyperia.meeting_exists(meeting_id)

if not response:
  	sys.exit(-1)

exists = response['exists']