Skip to main content
POST
Create a join token

Authorizations

Authorization
string
header
required

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

Path Parameters

room_name
string
required

Body

application/json

Request a join token for one participant, in the languages they speak.

identity
string
required

Who the token is issued for — this is how that participant appears in the room, and how their connection is attributed in the room's usage breakdown. Two participants of the same room must not share an identity.

Example:

"alice"

languages
enum<string>[]
required

The languages this participant speaks and wants to hear, from GET /v1/supported-languages. Usually one. Send two when a single connection covers two people — for example two colleagues sharing one phone — which is enough on its own to start the translator.

How many you send fixes the room's streaming mode, and then has to keep matching it. The first token for a room with no mode sets it: two languages makes it mono, one makes it dual. Every later token for that room must carry the same count or the request returns 409 — so a dual room takes one language per participant, and a mono room takes two on each connection.

A room translates between at most two languages, so a request that would make a third returns 409. Once a participant disconnects, their language frees up again.

Required array length: 1 - 2 elements
Available options:
ar,
ca,
da,
de,
el,
en,
es,
fi,
fr,
he,
hi,
hu,
it,
ja,
ko,
nl,
no,
pl,
pt,
ro,
ru,
sv,
tr,
uk,
ur,
zh
Examples:

Response

Successful Response

Credentials for one participant to join a room.

Connect a client to url with token. The token is short-lived, and the participant is disconnected when it expires.

The translator joins the room by itself once two languages are present, and leaves when fewer than two remain — there is nothing to call for it.

room
string
required
token
string
required
url
string
required
languages
enum<string>[]
required
Available options:
ar,
ca,
da,
de,
el,
en,
es,
fi,
fr,
he,
hi,
hu,
it,
ja,
ko,
nl,
no,
pl,
pt,
ro,
ru,
sv,
tr,
uk,
ur,
zh