PATCHhttps://core-api.heysadie.ai/assistants/{id}

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

The resource's UUID.

Display name of the assistant (e.g., Sadie, Alex)

The voice the assistant will use to speak to callers

The transcriber engine used to convert speech to text

The LLM model that powers the assistant's reasoning (e.g., GPT-4)

Custom prompt section developers can inject into the default assistant prompt

JSON object with dynamic values injected into developerPrompt (e.g., {{opening_hours}})

Whether call recordings are enabled for this assistant

The phone number to transfer calls to if the assistant fails to respond (E.164 format)

Turn on or off the failover mode (in case it's enabled, the call will be forwarded to the failover number)

The phone number this assistant is assigned to

The first message the assistant says when answering the call

List of tool IDs the assistant can use

Timezone of the business the assistant is handling calls for (e.g., Australia/Sydney)

Address of the business (used in prompt reasoning)

Final message before the call ends

Whether the assistant can read and reference the caller's phone number if not anonymous

Prompt used to control how the assistant summarizes the call transcript

Prompt that helps classify calls based on the categories field

List of categories the assistant can classify the call into (e.g., booking, edit)

The ID of the prompt associated with the assistant

Optional chat/messaging prompt ID (type 'chat'); null clears it

Optional whisper-summary prompt ID (type 'whisper_summary'); null clears it

Whether the assistant has a background sound

The webhook URL override for the assistant; null clears it

Array of notification webhook URLs for the assistant

Whether CSAT (Customer Satisfaction) feedback is enabled for this assistant

Array of messages to send when the assistant detects the caller is idle

Transfer mode behavior for escalations. Defaults to 'cold-transfer' if not provided.

Maximum call duration in seconds. Must be between 10 and 43200 (12 hours). Null means no limit.

Number of seconds to wait before considering the caller idle. Min 0 - Max 60.

Maximum number of times idle messages can be spoken before ending the call. Min 0 - Max 10.

Per-assistant settings container. Currently holds conversationConfig; additional setting categories will be added here in the future. Structure: { conversationConfig: { endpointingPlan?: { mode?: "fixed"|"dynamic", minDelay?, maxDelay? }, turnDetectionPlan?: { timeout?, unlikelyThreshold? }, vadPlan?: { minSpeechDuration?, minSilenceDuration?, prefixPaddingDuration? }, interruptionPlan?: { minDuration? (0-5), minWords? (0-10) }, deliveryMode?: "none"|"emotion_tagging"|"expressive", expressiveOptions?: { disfluencies?: boolean, nonverbalSounds?: boolean | { laughing?, breathing?, sighing?, crying?, vocalizing?, mouthSounds?, reflexSounds? }, pace?: "slow"|"normal"|"fast", instructionsAppend?: string (max 2000) } | null, emotionTaggingEnabled?: boolean (legacy; superseded by deliveryMode) } }

Dial timeout in seconds for transfer attempts. Integer between 1 and 60. Merged into settings.transferDialTimeout; other settings keys are preserved.

Pause in seconds before the warm-transfer whisper plays to the supervisor. Integer between 0 and 30. Defaults to 0 when omitted. Merged into settings.warmWhisperDelaySeconds; other settings keys are preserved.

What the assistant says when a warm-return transfer goes unanswered and the caller comes back. Max 2000 characters. Merged into settings.warmReturnMessage; other settings keys are preserved. Send "" to restore the built-in wording. Set this to match whatever your server does when it receives supervisor_answered: false on the end-of-call report.

When true, CoreProxy leaves {tool_instructions} empty and sends linked taskgroups/tasks as structured data to AgentSpawn. When false (default), the existing prompt pipeline runs unchanged.

IVR (phone-menu) configuration for this assistant. Free-form JSON object; no inner structure is validated yet while the feature is in progress. IMPORTANT: this does NOT merge the way `settings` does — the object you send REPLACES the stored one entirely, so read the current value from GET /assistants/{id}, modify it, and send it back whole. Send null to clear it (null = no IVR configured). Omit the field to leave it unchanged.