Skip to main content
POST
Create and connect an assistant automation

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

Path Parameters

id
string<uuid>
required

Assistant ID.

Body

application/json
tool_description
string
required

Explain exactly when the assistant should run this automation.

Required string length: 10 - 1000
name
string
Maximum string length: 200

Response

Draft automation created and connected.