interview-realtime

Get Interview Session Info

Return public session metadata after validating the invite token.

get/v1/interview/session/{session_id}

Path parameters

session_idstring required

Query parameters

tokenstring nullable
modestring nullable

Response

Successful Response

session_idstring uuid required
interview_typestring required
default_modestring required
statusstring required
transcriptobject[] nullable
duration_limit_minutesinteger nullable
duration_remaining_secondsinteger nullable
contact_namestring nullable
contact_emailstring nullable
contact_image_urlstring nullable
company_namestring nullable
company_domainstring nullable
company_logo_urlstring nullable
workspace_idstring uuid nullable
workspace_clerk_org_idstring nullable
workspace_namestring nullable
workspace_domainstring nullable
workspace_logo_urlstring nullable
page_titlestring nullable
screen_share_enabledboolean
campaign_introstring nullable
default_languagestring
campaign_is_anonymousboolean
campaign_visibility_notestring nullable
campaign_results_usagestring nullable
participant_voice_selection_enabledboolean
participant_mode_selection_enabledboolean
participant_review_enabledboolean
selected_voice_idstring nullable
selected_voice_languagestring nullable
selected_voice_providerstring nullable
voice_providerstring nullable
voice_speednumber
selected_voice_speednumber nullable
is_anonymousboolean
anonymity_levelstring
campaign_anonymity_levelstring
participant_anonymity_selection_enabledboolean
selected_anonymity_levelstring nullable
record_audioboolean
can_email_resume_linkboolean
session_feedback_submittedboolean
deepgram_eot_timeout_msinteger nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.