Skip to main content
POST
Preview a natural-language dashboard plan

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments: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.

Path Parameters

id
string<uuid>
required

Dashboard ID.

Body

application/json
prompt
string
required
Required string length: 8 - 1200
Example:

"Show success rate and average duration for outbound calls in the last 30 days"

Response

Validated preview plan. No dashboard data has changed.

data
object
required

Versioned, tenant-safe dashboard plan built exclusively from the semantic analytics catalog.