Skip to main content
POST
Join a room with an invite link

Path Parameters

invite_code
string
required

Body

application/json

The languages a guest is joining in.

The same shape as JoinTokenRequest.languages, and deliberately so: a guest's join is a join token like any other, and the room's streaming mode decides how many languages one carries — see languages_required on the preview.

languages
enum<string>[]
required

The languages this guest speaks and wants to hear, each one of the active_languages from GET /v1/invites/{invite_code}.

Send exactly as many as that response's languages_required. One for a dual room — the guest is on their own device — and two for a mono room, where one device carries both speakers. A count that disagrees with the room's mode returns 409 and spends none of the link's uses.

When languages_required is null the room has no mode yet and this count settles it, exactly as the first room token would: one language makes the room dual, two makes it mono, and it is fixed from then on.

Required array length: 1 - 2 elements
Available options:
ar-EG,
ca-ES,
da-DK,
de-DE,
el-GR,
en-GB,
es-ES,
fi-FI,
fr-FR,
he-IL,
hi-IN,
hu-HU,
it-IT,
ja-JP,
ko-KR,
nl-NL,
no-NO,
pl-PL,
pt-PT,
ro-RO,
ru-RU,
sv-SE,
tr-TR,
uk-UA,
ur-PK,
zh-CN
Examples:

Response

Successful Response

Credentials for a guest who redeemed an invite link.

The same shape every other participant gets, plus the identity they were assigned. Connect to url with token; the token is short-lived and the guest is disconnected when it expires.

Redeeming spends one of the link's uses, so this response is not repeatable — a guest who reloads and joins again consumes another.

room
string
required
token
string
required
url
string
required
languages
enum<string>[]
required
Available options:
ar-EG,
ca-ES,
da-DK,
de-DE,
el-GR,
en-GB,
es-ES,
fi-FI,
fr-FR,
he-IL,
hi-IN,
hu-HU,
it-IT,
ja-JP,
ko-KR,
nl-NL,
no-NO,
pl-PL,
pt-PT,
ro-RO,
ru-RU,
sv-SE,
tr-TR,
uk-UA,
ur-PK,
zh-CN
identity
string
required

Who this guest appears as in the room, and how their connection is attributed in the room's usage breakdown. Assigned by the server, not chosen: a guest is unauthenticated, so letting them name themselves would let them join as anyone.