Skip to main content
POST
Start a translation room
The initiating workspace user chooses both participants’ connections. Speaker 1 supports web, phone, or inbound; Speaker 2 supports web or phone. All six combinations are supported. Each phone participant requires an international E.164 destination and an eligible outgoing connection. An inbound participant instead uses the assistant’s assigned incoming number and room code; an outgoing connection is not required for dial-in itself. Start the room before entering its six-digit code by phone. Starting reserves the workspace’s available budget before outgoing calls are queued. Each actual phone connection has its own carrier charge; the shared conversation rate and translation surcharge apply once. Guests cannot start the room or request calls. When call recording is enabled for the Translate assistant, recording starts automatically unless spoken consent is also enabled. With consent enabled, both speakers hear a recording notice in their configured language before translation begins, and recording starts only after both people consent. The completed room is stored as one Translate history entry with its bilingual transcript and, when available, the recording from Speaker 1’s side. The Translate Agent mode must be included in the workspace’s current plan when the room is created or started.

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Body

application/json
speaker1
object
required
speaker2
object
required
phone_number_id
string<uuid>

Response

Success

data
object
required