API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Realtime Kit

Realtime KitApps

Fetch all apps

client.RealtimeKit.Apps.Get(ctx, query) (*AppGetResponse, error)

GET/accounts/{account_id}/realtime/kit/apps

Create App

client.RealtimeKit.Apps.Post(ctx, params) (*AppPostResponse, error)

POST/accounts/{account_id}/realtime/kit/apps

Realtime KitMeetings

Fetch all meetings for an App

client.RealtimeKit.Meetings.Get(ctx, appID, params) (*MeetingGetResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings

Create a meeting

client.RealtimeKit.Meetings.New(ctx, appID, params) (*MeetingNewResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings

Fetch a meeting for an App

client.RealtimeKit.Meetings.GetMeetingByID(ctx, appID, meetingID, params) (*MeetingGetMeetingByIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Update a meeting

client.RealtimeKit.Meetings.UpdateMeetingByID(ctx, appID, meetingID, params) (*MeetingUpdateMeetingByIDResponse, error)

PATCH/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Replace a meeting

client.RealtimeKit.Meetings.ReplaceMeetingByID(ctx, appID, meetingID, params) (*MeetingReplaceMeetingByIDResponse, error)

PUT/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}

Fetch all participants of a meeting

client.RealtimeKit.Meetings.GetMeetingParticipants(ctx, appID, meetingID, params) (*MeetingGetMeetingParticipantsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Add a participant

client.RealtimeKit.Meetings.AddParticipant(ctx, appID, meetingID, params) (*MeetingAddParticipantResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants

Fetch a participant's detail

client.RealtimeKit.Meetings.GetMeetingParticipant(ctx, appID, meetingID, participantID, query) (*MeetingGetMeetingParticipantResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Edit a participant's detail

client.RealtimeKit.Meetings.EditParticipant(ctx, appID, meetingID, participantID, params) (*MeetingEditParticipantResponse, error)

PATCH/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Delete a participant

client.RealtimeKit.Meetings.DeleteMeetingParticipant(ctx, appID, meetingID, participantID, body) (*MeetingDeleteMeetingParticipantResponse, error)

DELETE/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}

Refresh participant's authentication token

client.RealtimeKit.Meetings.RefreshParticipantToken(ctx, appID, meetingID, participantID, body) (*MeetingRefreshParticipantTokenResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token

Realtime KitPresets

Fetch all presets

client.RealtimeKit.Presets.Get(ctx, appID, params) (*PresetGetResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/presets

Create a preset

client.RealtimeKit.Presets.New(ctx, appID, params) (*PresetNewResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/presets

Fetch details of a preset

client.RealtimeKit.Presets.GetPresetByID(ctx, appID, presetID, query) (*PresetGetPresetByIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Delete a preset

client.RealtimeKit.Presets.Delete(ctx, appID, presetID, body) (*PresetDeleteResponse, error)

DELETE/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Update a preset

client.RealtimeKit.Presets.Update(ctx, appID, presetID, params) (*PresetUpdateResponse, error)

PATCH/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}

Realtime KitSessions

Fetch all sessions of an App

client.RealtimeKit.Sessions.GetSessions(ctx, appID, params) (*SessionGetSessionsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions

Fetch details of a session

client.RealtimeKit.Sessions.GetSessionDetails(ctx, appID, sessionID, params) (*SessionGetSessionDetailsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}

Fetch participants list of a session

client.RealtimeKit.Sessions.GetSessionParticipants(ctx, appID, sessionID, params) (*SessionGetSessionParticipantsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants

Fetch details of a participant

client.RealtimeKit.Sessions.GetSessionParticipantDetails(ctx, appID, sessionID, participantID, params) (*SessionGetSessionParticipantDetailsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}

Fetch all chat messages of a session

client.RealtimeKit.Sessions.GetSessionChat(ctx, appID, sessionID, query) (*SessionGetSessionChatResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat

Fetch the complete transcript for a session

client.RealtimeKit.Sessions.GetSessionTranscripts(ctx, appID, sessionID, query) (*SessionGetSessionTranscriptsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript

Fetch summary of transcripts for a session

client.RealtimeKit.Sessions.GetSessionSummary(ctx, appID, sessionID, query) (*SessionGetSessionSummaryResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Generate summary of Transcripts for the session

client.RealtimeKit.Sessions.GenerateSummaryOfTranscripts(ctx, appID, sessionID, body) error

POST/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Fetch details of peer

client.RealtimeKit.Sessions.GetParticipantDataFromPeerID(ctx, appID, peerID, params) (*SessionGetParticipantDataFromPeerIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}

Realtime KitRecordings

Fetch all recordings for an App

client.RealtimeKit.Recordings.GetRecordings(ctx, appID, params) (*RecordingGetRecordingsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/recordings

Start recording a meeting

client.RealtimeKit.Recordings.StartRecordings(ctx, appID, params) (*RecordingStartRecordingsResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/recordings

Fetch active recording

client.RealtimeKit.Recordings.GetActiveRecordings(ctx, appID, meetingID, query) (*RecordingGetActiveRecordingsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}

Fetch details of a recording

client.RealtimeKit.Recordings.GetOneRecording(ctx, appID, recordingID, query) (*RecordingGetOneRecordingResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}

Pause/Resume/Stop recording

client.RealtimeKit.Recordings.PauseResumeStopRecording(ctx, appID, recordingID, params) (*RecordingPauseResumeStopRecordingResponse, error)

PUT/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}

Start recording audio and video tracks

client.RealtimeKit.Recordings.StartTrackRecording(ctx, appID, params) error

POST/accounts/{account_id}/realtime/kit/{app_id}/recordings/track

Realtime KitWebhooks

Fetch all webhooks details

client.RealtimeKit.Webhooks.GetWebhooks(ctx, appID, query) (*WebhookGetWebhooksResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Add a webhook

client.RealtimeKit.Webhooks.NewWebhook(ctx, appID, params) (*WebhookNewWebhookResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Fetch details of a webhook

client.RealtimeKit.Webhooks.GetWebhookByID(ctx, appID, webhookID, query) (*WebhookGetWebhookByIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Replace a webhook

client.RealtimeKit.Webhooks.ReplaceWebhook(ctx, appID, webhookID, params) (*WebhookReplaceWebhookResponse, error)

PUT/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Edit a webhook

client.RealtimeKit.Webhooks.EditWebhook(ctx, appID, webhookID, params) (*WebhookEditWebhookResponse, error)

PATCH/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Delete a webhook

client.RealtimeKit.Webhooks.DeleteWebhook(ctx, appID, webhookID, body) (*WebhookDeleteWebhookResponse, error)

DELETE/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Realtime KitActive Session

Fetch details of an active session

client.RealtimeKit.ActiveSession.GetActiveSession(ctx, appID, meetingID, query) (*ActiveSessionGetActiveSessionResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session

Kick participants from an active session

client.RealtimeKit.ActiveSession.KickParticipants(ctx, appID, meetingID, params) (*ActiveSessionKickParticipantsResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick

Kick all participants

client.RealtimeKit.ActiveSession.KickAllParticipants(ctx, appID, meetingID, body) (*ActiveSessionKickAllParticipantsResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all

Create a poll

client.RealtimeKit.ActiveSession.NewPoll(ctx, appID, meetingID, params) (*ActiveSessionNewPollResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll

Realtime KitLivestreams

Create an independent livestream

client.RealtimeKit.Livestreams.NewIndependentLivestream(ctx, appID, params) (*LivestreamNewIndependentLivestreamResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Fetch all livestreams

client.RealtimeKit.Livestreams.GetAllLivestreams(ctx, appID, params) (*LivestreamGetAllLivestreamsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Stop livestreaming a meeting

client.RealtimeKit.Livestreams.StopLivestreamingAMeeting(ctx, appID, meetingID, body) (*LivestreamStopLivestreamingAMeetingResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop

Start livestreaming a meeting

client.RealtimeKit.Livestreams.StartLivestreamingAMeeting(ctx, appID, meetingID, params) (*LivestreamStartLivestreamingAMeetingResponse, error)

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams

Fetch complete analytics data for your livestreams

client.RealtimeKit.Livestreams.GetLivestreamAnalyticsComplete(ctx, appID, params) (*LivestreamGetLivestreamAnalyticsCompleteResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall

Fetch day-wise session and recording analytics data for an App

client.RealtimeKit.Livestreams.GetOrgAnalytics(ctx, appID, params) (*LivestreamGetOrgAnalyticsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise

Fetch active livestreams for a meeting

client.RealtimeKit.Livestreams.GetMeetingActiveLivestreams(ctx, appID, meetingID, query) (*LivestreamGetMeetingActiveLivestreamsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream

Fetch livestream session details using livestream session ID

client.RealtimeKit.Livestreams.GetLivestreamSessionDetailsForSessionID(ctx, appID, livestreamSessionID, query) (*LivestreamGetLivestreamSessionDetailsForSessionIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}

Fetch active livestream session details

client.RealtimeKit.Livestreams.GetActiveLivestreamsForLivestreamID(ctx, appID, livestreamID, query) (*LivestreamGetActiveLivestreamsForLivestreamIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session

Fetch livestream details using livestream ID

client.RealtimeKit.Livestreams.GetLivestreamSessionForLivestreamID(ctx, appID, livestreamID, params) (*LivestreamGetLivestreamSessionForLivestreamIDResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}

Realtime KitAnalytics

Fetch day-wise session and recording analytics data for an App

client.RealtimeKit.Analytics.GetOrgAnalytics(ctx, appID, params) (*AnalyticsGetOrgAnalyticsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise