Skip to main content
POST

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

Body

application/json
​
action
string
required
Allowed value: "preview"
​
provider
enum<string>
required
Available options:
retell,
vapi,
synthflow
​
source_api_key
string
required
write-only

Private source-provider API key. Never include it in chat or logs.

​
synthflow_region
enum<string>

Synthflow workspace region. Omit for Global.

Available options:
global,
us,
eu

Response

Normalized preview or per-assistant import report.

​
data
object
required