Skip to main content
POST
Create an assistant

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.

Body

application/json
name
string
required

Display name for the assistant.

Minimum string length: 1
description
string
prompt
string

System prompt. If omitted, a minimal default prompt is generated from the name.

model
enum<string>

LLM model. Defaults to KIMI_K2_5 when omitted.

Available options:
QWEN_3_235B_A22B,
GPT_5_4,
GPT_5_2,
GPT_5_1,
GPT_5,
GPT_5_MINI,
GPT_5_NANO,
GPT_4_1,
GPT_4_1_MINI,
GPT_4_1_NANO,
GPT_4O,
GPT_4O_MINI,
GPT_4_TURBO,
GPT_4,
GPT_3_5_TURBO,
CLAUDE_4_1_OPUS,
CLAUDE_4_SONNET,
CLAUDE_3_7_SONNET,
CLAUDE_HAIKU_4_5,
CLAUDE_3_5_HAIKU,
CLAUDE_3_SONNET,
CLAUDE_3_HAIKU,
GEMINI_2_5_FLASH,
GEMINI_2_0_FLASH,
GEMINI_2_0_FLASH_LITE,
KIMI_K2_5,
KIMI_K2_6,
CUSTOM
temperature
number

Sampling temperature 0–2 (default 0).

Required range: 0 <= x <= 2
voice_id
string

Voice PK (the id from GET /v3/voices). Defaults to the system default voice when omitted.

assistant_type
enum<string>

Assistant type. STANDARD (default) is a prompt-driven assistant; FLOW_BUILDER is node/flow driven.

Available options:
STANDARD,
FLOW_BUILDER
language
string

BCP-47 language code (default 'en').

voice_enabled
boolean

Whether voice calling is enabled (default true).

inbound_greeting
string
outbound_greeting
string
platform_tools
string[]

Platform tool names to attach, e.g. ["book_appointment", "send_email"]. Declarative within the platform catalog: tools in the list are attached, catalog tools missing from the list are detached, custom tools are never touched. Omit for no change; [] detaches all platform tools. See GET /v3/tools for the catalog; custom tools attach via POST /v3/tools/{id}/assign.

voice_settings
object
subaccount_id
string

Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.

location_id
string

Alias for subaccount_id (GHL location id).

Response

Success

data
object
required
request_id
string
required
error
null