Skip to main content
GET
/
studies
/
{studyId}
/
interviews
/
{interviewBookingId}
/
observer-room
Get the observer room for an interview
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/interviews/{interviewBookingId}/observer-room \
  --header 'Authorization: Bearer <token>'
{
  "observerRoomId": "<string>",
  "interviewBookingId": "<string>",
  "studyId": "<string>",
  "title": "<string>",
  "note": "<string>",
  "guestUserIds": [
    "<string>"
  ],
  "externalGuests": [
    "<string>"
  ],
  "linkWithPassword": "<string>",
  "bots": [
    {
      "observerRoomBotId": "<string>",
      "observerRoomId": "<string>",
      "video": {
        "hasVideo": true,
        "downloadUrl": "<string>"
      },
      "transcript": {
        "hasTranscript": true,
        "transcriptUrl": "<string>",
        "shortSummary": "<string>",
        "longSummary": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
studyId
string
required
​
interviewBookingId
string
required

Response

The observer room

​
observerRoomId
string
required
​
interviewBookingId
string
required
​
studyId
string
required
​
title
string | null
required
​
note
string | null
required
​
guestUserIds
string[]
required

The rally userIds associated with the observer room

​
externalGuests
string[]
required

The external guests associated with the observer room

​
linkWithPassword
string
required

The full observer room link including the password

​
bots
object[]
required

The bots associated with the observer room