Skip to main content
POST
Create a translation room

Authorizations

Authorization
string
header
required

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

Body

application/json

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.

room_name
string | null

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.

Example:

"standup"

streaming_mode
enum<string> | null

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.

Available options:
mono,
dual
Example:

"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.

id
string<uuid>
required
room
string
required
url
string
required
streaming_mode
string | null
required