Join a room publicly (no API key required)

Authorization

tenant-api-key

x-api-key<token>

Tenant API key (backend only — never expose to a browser)

In: header

Path Parameters

id*string

Room CUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalUserId*string

Consuming app's user ID

displayName*string

Lengthlength <= 100

avatarUrl?string

role?string

Participant role: HOST, CO_HOST, PRESENTER, ATTENDEE, VIEWER

Default"ATTENDEE"

Value in

"HOST"
"CO_HOST"
"PRESENTER"
"ATTENDEE"
"VIEWER"

canPublish?boolean

Override: can publish audio/video

canSubscribe?boolean

Override: can subscribe to tracks

canPublishData?boolean

Override: can publish data messages

canScreenShare?boolean

Override: can share screen

canRecord?boolean

Override: can start recording

externalRole?string

Domain role from consuming app (e.g., "doctor", "patient")

externalMetadata?

Arbitrary JSON metadata from the consuming app

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rooms/string/public-join" \  -H "Content-Type: application/json" \  -d '{    "externalUserId": "user_abc123",    "displayName": "Dr. Jane Smith"  }'

{  "token": {},  "livekitUrl": {},  "joinUrl": {},  "waitingForApproval": true,  "participant": {    "id": "string",    "roomId": "string",    "externalUserId": "string",    "displayName": "string",    "avatarUrl": {},    "livekitIdentity": "string",    "livekitSid": {},    "role": "HOST",    "canPublish": true,    "canSubscribe": true,    "canPublishData": true,    "canScreenShare": true,    "canRecord": true,    "isApproved": true,    "approvedBy": {},    "connectionState": "PENDING",    "joinedAt": {},    "leftAt": {},    "duration": {},    "rejoinCount": 0,    "externalRole": {},    "externalMetadata": {},    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "room": {    "id": "string",    "tenantId": "string",    "name": "string",    "slug": "string",    "livekitRoomName": "string",    "type": "INSTANT",    "maxParticipants": 0,    "enableRecording": true,    "enableChat": true,    "enableScreenShare": true,    "enableWaitingRoom": true,    "enableE2EE": true,    "enableAiFeatures": true,    "allowPublicJoin": true,    "recordingPreset": "string",    "isLocked": true,    "autoRecord": true,    "status": "WAITING",    "scheduledAt": {},    "startedAt": {},    "autoEndAt": {},    "endedAt": {},    "duration": {},    "livekitSid": {},    "activeParticipants": 0,    "reopenCount": 0,    "createdByExternalId": "string",    "externalId": {},    "externalType": {},    "externalMetadata": {},    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "participants": [      {        "id": "string",        "roomId": "string",        "externalUserId": "string",        "displayName": "string",        "avatarUrl": {},        "livekitIdentity": "string",        "livekitSid": {},        "role": "HOST",        "canPublish": true,        "canSubscribe": true,        "canPublishData": true,        "canScreenShare": true,        "canRecord": true,        "isApproved": true,        "approvedBy": {},        "connectionState": "PENDING",        "joinedAt": {},        "leftAt": {},        "duration": {},        "rejoinCount": 0,        "externalRole": {},        "externalMetadata": {},        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  }}