Create a translation room
Create a live translation room.
Languages are not set here. Each participant declares their own when you request their join token, so you can create a room before knowing who will be in it or what they speak. The translator joins on its own once the room holds two languages, and leaves when fewer than two remain — you never dispatch or dismiss it yourself.
The response carries the room’s id, for looking up its usage later, and the realtime
url your clients connect to. Get a token for each participant, including the first,
from POST /v1/rooms/{room_name}/token.
room_name must be unique among rooms that are currently live; reusing the name
of a live room returns 409. Omit it to have one generated.
streaming_mode records how the room’s audio will arrive — mono when both languages
come from one device, dual when each speaker has their own. It is optional: omit it
and the room’s first join token decides, by how many languages it asks for. Either
way the mode is fixed for the room’s lifetime and every later join token must match it.
Requires credit: a room cannot be started while the organization’s balance is at or below zero, and the request returns 402 if it is. A call already in progress is never cut off, so a long room can run the balance negative.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request to create a translation room.
Nothing is required. Languages are not set here — each participant declares their own when you request their join token, so a room can be created before anyone has chosen one.
Optional. A name for the room, which must not be in use by another room that is currently live. Omit it and a unique name is generated, returned as room in the response.
"standup"
Optional. How this room's audio will reach the translator:
mono— both languages come from the same device, such as two colleagues sharing one phone.dual— each speaker joins from their own device.
Omit it and the first join token decides: a token requesting two languages makes the room mono, one language makes it dual. Either way the mode is fixed for the room's lifetime, and every later join token must match it or the request returns 409 — so set it here when you already know, to get that error on the room instead of on your first token.
mono, dual "dual"
Response
Successful Response
A created room, ready for participants.
Creating a room does not issue any credentials — get a join token for each
participant from POST /v1/rooms/{room_name}/token, which is also where that
participant's languages are set. Use id to look the room and its usage up later.