Assistants
Create an assistant
Get assistants
Get assistant by ID
Update an assistant
Delete an assistant
Clone an assistant
ModelsExpand Collapse
AssistantCreateResponse { assistant }
assistant: Assistant { id, after_call_sms_outcomes, after_call_sms_prompt, 51 more }
after_call_sms_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly | null
The connection ID representing the link between your Calendly account and Revox.
The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
call_retry_config: CallRetryConfig | nullConfiguration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.
calling_windows: Array<CallingWindow>
End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array<CustomTool> | null
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array<Header>HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array<InputSchema>Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. “alice@x.com, bob@y.com”).
email_notification_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Which call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot | null
meeting_links: Array<MeetingLink>Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent texts this to the caller when it can’t complete the booking itself. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
human_transfer_mode: "warm" | "cold" | nullWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
llm_model: UnionMember0 { name, type } | UnionMember1 { openrouter_model_id, openrouter_provider, type } | UnionMember2 { api_key, api_url, model_name, type } | UnionMember3 { provider, realtime_model_id, type, realtime_voice_id }
Public URL of the brand logo shown on the assistant’s demo page. Null when unset.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack | null
channels: Array<Channel>The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.
Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.
Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.
structured_output_config: Array<StructuredOutputConfig> | nullThe structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
stt_context: SttContext | nullAssistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | nullAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array<TransferDestination> | nullWhere calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice | null
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
zoho: Zoho | null
field_mapping: Array<FieldMapping>Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.
AssistantListResponse { assistants }
assistants: Array<Assistant>
after_call_sms_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly | null
The connection ID representing the link between your Calendly account and Revox.
The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
call_retry_config: CallRetryConfig | nullConfiguration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.
calling_windows: Array<CallingWindow>
End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array<CustomTool> | null
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array<Header>HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array<InputSchema>Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. “alice@x.com, bob@y.com”).
email_notification_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Which call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot | null
meeting_links: Array<MeetingLink>Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent texts this to the caller when it can’t complete the booking itself. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
human_transfer_mode: "warm" | "cold" | nullWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
llm_model: UnionMember0 { name, type } | UnionMember1 { openrouter_model_id, openrouter_provider, type } | UnionMember2 { api_key, api_url, model_name, type } | UnionMember3 { provider, realtime_model_id, type, realtime_voice_id }
Public URL of the brand logo shown on the assistant’s demo page. Null when unset.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack | null
channels: Array<Channel>The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.
Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.
Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.
structured_output_config: Array<StructuredOutputConfig> | nullThe structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
stt_context: SttContext | nullAssistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | nullAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array<TransferDestination> | nullWhere calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice | null
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
zoho: Zoho | null
field_mapping: Array<FieldMapping>Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.
AssistantRetrieveResponse { id, after_call_sms_outcomes, after_call_sms_prompt, 51 more }
after_call_sms_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly | null
The connection ID representing the link between your Calendly account and Revox.
The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
call_retry_config: CallRetryConfig | nullConfiguration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.
calling_windows: Array<CallingWindow>
End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array<CustomTool> | null
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array<Header>HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array<InputSchema>Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. “alice@x.com, bob@y.com”).
email_notification_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Which call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot | null
meeting_links: Array<MeetingLink>Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent texts this to the caller when it can’t complete the booking itself. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
human_transfer_mode: "warm" | "cold" | nullWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
llm_model: UnionMember0 { name, type } | UnionMember1 { openrouter_model_id, openrouter_provider, type } | UnionMember2 { api_key, api_url, model_name, type } | UnionMember3 { provider, realtime_model_id, type, realtime_voice_id }
Public URL of the brand logo shown on the assistant’s demo page. Null when unset.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack | null
channels: Array<Channel>The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.
Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.
Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.
structured_output_config: Array<StructuredOutputConfig> | nullThe structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
stt_context: SttContext | nullAssistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | nullAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array<TransferDestination> | nullWhere calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice | null
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
zoho: Zoho | null
field_mapping: Array<FieldMapping>Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.
AssistantUpdateResponse { assistant, unpatchedCallsNotice }
assistant: Assistant { id, after_call_sms_outcomes, after_call_sms_prompt, 51 more }
after_call_sms_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly | null
The connection ID representing the link between your Calendly account and Revox.
The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
call_retry_config: CallRetryConfig | nullConfiguration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.
calling_windows: Array<CallingWindow>
End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array<CustomTool> | null
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array<Header>HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array<InputSchema>Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. “alice@x.com, bob@y.com”).
email_notification_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Which call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot | null
meeting_links: Array<MeetingLink>Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent texts this to the caller when it can’t complete the booking itself. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
human_transfer_mode: "warm" | "cold" | nullWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
llm_model: UnionMember0 { name, type } | UnionMember1 { openrouter_model_id, openrouter_provider, type } | UnionMember2 { api_key, api_url, model_name, type } | UnionMember3 { provider, realtime_model_id, type, realtime_voice_id }
Public URL of the brand logo shown on the assistant’s demo page. Null when unset.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack | null
channels: Array<Channel>The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.
Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.
Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.
structured_output_config: Array<StructuredOutputConfig> | nullThe structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
stt_context: SttContext | nullAssistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | nullAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array<TransferDestination> | nullWhere calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice | null
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
zoho: Zoho | null
field_mapping: Array<FieldMapping>Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.
AssistantCloneResponse { assistant }
assistant: Assistant { id, after_call_sms_outcomes, after_call_sms_prompt, 51 more }
after_call_sms_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use “none” when outcome is null.
Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly | null
The connection ID representing the link between your Calendly account and Revox.
The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)
call_retry_config: CallRetryConfig | nullConfiguration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.
allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.
calling_windows: Array<CallingWindow>
End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array<CustomTool> | null
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array<Header>HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array<InputSchema>Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. “alice@x.com, bob@y.com”).
email_notification_outcomes: Array<"not_interested" | "interested" | "completed" | 2 more> | nullWhich call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Which call outcomes trigger an email notification. E.g. [“interested”, “completed”, “none”]. Use “none” when outcome is null.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot | null
meeting_links: Array<MeetingLink>Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent texts this to the caller when it can’t complete the booking itself. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
human_transfer_mode: "warm" | "cold" | nullWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
llm_model: UnionMember0 { name, type } | UnionMember1 { openrouter_model_id, openrouter_provider, type } | UnionMember2 { api_key, api_url, model_name, type } | UnionMember3 { provider, realtime_model_id, type, realtime_voice_id }
Public URL of the brand logo shown on the assistant’s demo page. Null when unset.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack | null
channels: Array<Channel>The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Which call outcomes trigger a Slack notification (e.g. [‘interested’, ‘none’]). Use ‘none’ to notify when outcome is null.
Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.
Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.
Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.
structured_output_config: Array<StructuredOutputConfig> | nullThe structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
stt_context: SttContext | nullAssistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.
thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | nullAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array<TransferDestination> | nullWhere calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice | null
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
zoho: Zoho | null
field_mapping: Array<FieldMapping>Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
outcomes: Array<"not_interested" | "interested" | "completed" | 2 more>Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Which call outcomes trigger the Zoho push (e.g. [‘interested’, ‘none’]). Use ‘none’ to push when outcome is null.
Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.