--- updatedAt: 2026-08-17T22:49:45.000Z agentTools: projectIndex: https://docs.whippy.ai/llms.txt --- # Delete Agent Deletes an agent that belongs to the authenticated organization. # OpenAPI definition ```json { "components": { "schemas": { "NotAuthenticatedErrorResponse": { "description": "Not Authenticated Error Response schema", "example": { "errors": [ { "description": "Not authenticated" } ], "status": 401 }, "properties": { "errors": { "description": "Not authenticated error", "items": { "properties": { "description": { "enum": [ "Not authenticated" ], "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "enum": [ 401 ], "type": "integer", "x-struct": null, "x-validate": null } }, "title": "NotAuthenticatedErrorResponse", "type": "object", "x-struct": "Elixir.DashboardApiWeb.Public.V1.Documentation.Errors.NotAuthenticated", "x-validate": null }, "ShowAgentResponse": { "description": "Response schema for agent records.", "example": { "data": { "assigned_call_flows": [ { "channels": [ { "address": "123 Main St, Anytown, USA", "id": "919b3b06-3d01-442d-9a9e-02a2892a3fee", "name": "Carl Sagan", "phone": "+11234567890", "state": "enabled", "type": "phone" } ], "color": "#FFA500", "created_by_id": 1, "description": "Call flow from the AI Agent Adrian that forwards the call to him", "emoji": "🤖", "id": "8b67c259-4550-47a7-82b1-4aa1a2428971", "name": "Forward to Agent: Adrian", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "updated_by_id": 1 } ], "created_at": "2024-02-28T12:33:40Z", "created_by": { "email": "carl@gmail.com", "id": 1, "name": "Carl Sagan", "phone": "+142481208301" }, "current_version": { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:56:24.260121Z", "created_by_id": 1, "description": "Law Agent", "id": "d2b27b17-65e1-47e8-a434-df60404011c1", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": "Adrian", "notes": "Updated the greeting and escalation instructions", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "placeholders_filters": {}, "published_at": "2024-04-30T08:56:24Z", "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } }, "default_call_flow": { "color": "#FFA500", "created_by_id": 1, "description": "Call flow from the AI Agent Adrian that forwards the call to him", "emoji": "🤖", "id": "8b67c259-4550-47a7-82b1-4aa1a2428971", "name": "Forward to Agent: Adrian", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "updated_by_id": 1 }, "deleted_at": null, "deleted_by": null, "draft_version": { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:56:24.260121Z", "created_by_id": 1, "description": "Law Agent", "id": "d2b27b17-65e1-47e8-a434-df60404011c1", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": "Adrian", "notes": "Updated the greeting and escalation instructions", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "placeholders_filters": {}, "published_at": "2024-04-30T08:56:24Z", "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } }, "id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "organization": { "id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "name": "Hello Inc." }, "status": "active", "updated_at": "2024-02-28T12:38:32Z", "updated_by": { "email": "carl@gmail.com", "id": 1, "name": "Carl Sagan", "phone": "+142481208301" }, "usage_mode": "ai_minutes", "versions": [ { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:52:17.493485Z", "created_by_id": 1, "description": null, "id": "25af6b4b-5b1c-4162-a428-c4a3245f4c5f", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": null, "notes": null, "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "published_at": null, "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } } ] } }, "properties": { "data": { "description": "Agent record", "properties": { "assigned_call_flows": { "description": "Data for the call flows that the agent is assigned to", "items": { "description": "Data for the call flow that the agent is assigned to", "example": { "color": "#FFA500", "created_by_id": 1, "description": "Call flow from the AI Agent Adrian that forwards the call to him", "emoji": "🤖", "id": "8b67c259-4550-47a7-82b1-4aa1a2428971", "name": "Forward to Agent: Adrian", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "updated_by_id": 1 }, "properties": { "channels": { "description": "Channels associated with the call flow", "example": [ { "address": "123 Main St, Anytown, USA", "id": "919b3b06-3d01-442d-9a9e-02a2892a3fee", "name": "Carl Sagan", "phone": "+11234567890", "state": "enabled", "type": "phone" } ], "items": { "description": "Channel data", "example": { "address": "123 Main St, Anytown, USA", "id": "919b3b06-3d01-442d-9a9e-02a2892a3fee", "name": "Carl Sagan", "phone": "+11234567890", "state": "enabled", "type": "phone" }, "properties": { "address": { "description": "Channel address", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Channel ID", "example": "919b3b06-3d01-442d-9a9e-02a2892a3fee", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Channel name", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "Channel phone", "type": "string", "x-struct": null, "x-validate": null }, "state": { "description": "Channel state", "example": "enabled", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Channel type", "example": "phone", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "color": { "description": "Call flow color", "example": "#000000", "type": "string", "x-struct": null, "x-validate": null }, "created_by_id": { "description": "User ID that created the call flow", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Call flow description", "example": "Call flow from the AI Agent Adrian that forwards the call to him", "type": "string", "x-struct": null, "x-validate": null }, "emoji": { "description": "Call flow emoji", "example": "🤖", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Call flow ID", "example": "8b67c259-4550-47a7-82b1-4aa1a2428971", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Call flow name", "example": "Forward to Agent: Adrian", "type": "string", "x-struct": null, "x-validate": null }, "organization_id": { "description": "Organization ID that the call flow belongs to", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "updated_by_id": { "description": "User ID that updated the call flow", "example": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "created_at": { "description": "Time of creation of the agent in ISO 8601 format", "example": "2024-01-06T12:19:39Z", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "created_by": { "description": "Data for the user that created the agent", "example": { "email": "carl@gmail.com", "id": 1, "name": "Carl Sagan", "phone": "+142481208301" }, "properties": { "email": { "description": "User email", "example": "carl@gmail.com", "format": "email", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "User ID", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "name": { "description": "User name", "example": "Carl Sagan", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "User phone", "example": "+142481208301", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "current_version": { "description": "Agent current version", "example": { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:56:24.260121Z", "created_by_id": 1, "description": "Law Agent", "id": "d2b27b17-65e1-47e8-a434-df60404011c1", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": "Adrian", "notes": "Updated the greeting and escalation instructions", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "placeholders_filters": {}, "published_at": "2024-04-30T08:56:24Z", "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } }, "properties": { "agent_id": { "description": "ID of agent that the agent version belongs to", "example": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "description": "Time of creation of the agent version in ISO 8601 format", "example": "2024-04-30T08:56:24.260121Z", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "created_by_id": { "description": "ID of the user that created the agent version", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Agent description", "example": "Law Agent", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Agent version ID", "example": "d2b27b17-65e1-47e8-a434-df60404011c1", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "llm_id": { "description": "ID of the LLM in use by the agent version", "example": "a3698a2e-49ff-482e-abac-261ed384fe69", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Agent name", "example": "Adrian", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Notes about the agent version", "example": "Updated the greeting and escalation instructions", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "organization_id": { "description": "ID of organization that the agent version belongs to", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "placeholders_filters": { "additionalProperties": { "properties": { "filter": { "description": "Filter rules that define which records populate the variable.", "items": { "properties": { "column": { "description": "The column on the resource on which the comparison should be executed.", "example": "status", "type": "string", "x-struct": null, "x-validate": null }, "comparison": { "description": "The comparison operator to use.", "enum": [ "==", "!=", "<", ">", "<=", ">=", "in", "like", "ilike", "not_in", "contains", "not_contains", "is_contained", "not_like", "not_ilike", "ilike_any", "not_ilike_all", "between", "in_radius", "not_in_radius" ], "example": "==", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "The resource on which the filter should be applied.", "example": "job", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Value to compare. Its type depends on the comparison operator.", "example": "active", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "comparison", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "limit": { "description": "Maximum number of records to return for the variable.", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "sort": { "description": "Rules that define how the returned records are sorted.", "items": { "properties": { "column": { "description": "Resource column to sort by.", "example": "created_at", "type": "string", "x-struct": null, "x-validate": null }, "order": { "description": "Sort direction.", "enum": [ "asc", "desc" ], "example": "desc", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "Resource to sort.", "example": "job", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "order" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "filter" ], "type": "object", "x-struct": null, "x-validate": null }, "description": "User-defined variables populated by filtering records with Whippy Query Language (WQL).\n\nEach key is a variable name, such as `available_jobs`. Its value contains the `filter` rules that define which\nrecords populate the variable and may also contain `limit` and `sort`.\n\nAt runtime, Whippy filters records for the current contact and, where applicable, the current agent, then makes\nthe results available in the agent instructions:\n\n * `{{@repeat available_jobs}}...{{@endrepeat}}` repeats the enclosed content for each matching record.\n Fields within the repeated content can use placeholders such as `{{custom.job.title}}`.\n * `{{@if available_jobs}}...{{@else}}...{{@endif}}` renders the first block when records match, or the\n optional `@else` block when none match.\n", "example": { "available_jobs": { "filter": [ { "column": "status", "comparison": "==", "resource": "job", "value": "active" } ], "limit": 10, "sort": [ { "column": "created_at", "order": "desc", "resource": "job" } ] } }, "type": "object", "x-struct": null, "x-validate": null }, "published_at": { "description": "Time the agent version was published in ISO 8601 format", "example": "2024-04-30T08:56:24Z", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "settings": { "additionalProperties": false, "description": "Agent settings", "properties": { "allow_user_dtmf": { "default": true, "description": "Agent allow user DTMF option.\n\nControls whether the agent allows the user to input DTMF (Dual-tone multi-frequency) signals (e.g., pressing keys on the phone keypad) during the call.\n", "example": true, "type": "boolean", "x-struct": null, "x-validate": null }, "ambient_sound": { "description": "Agent ambient environment sound", "enum": [ "coffee-shop", "convention-hall", "summer-outdoor", "mountain-outdoor", "static-noise", "call-center" ], "example": "coffee-shop", "type": "string", "x-struct": null, "x-validate": null }, "ambient_sound_volume": { "default": 1, "description": "Agent ambient environment sound volume, from 0 to 2.", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_frequency": { "default": 0.8, "description": "Agent backchannel frequency.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement. Must be from 0 to 1.\n", "example": 0.8, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_words": { "description": "Agent backchannel words.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": [ "okay", "uh-huh", "mhmm", "yah" ], "items": { "description": "Backchannel word", "example": "okay", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "begin_message_delay_ms": { "default": 0, "description": "Agent begin message delay ms setting.\n\nControls the time in milliseconds that the agent will wait once the call starts before saying the begin message. Must be from 0 to 5000.\n", "example": 0, "maximum": 5000, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "boosted_keywords": { "description": "Agent boosted keywords to bias the STT (Speech To Text) model.\n\nCommonly used for names, brands, street, etc.\n", "example": [ "Whippy" ], "items": { "description": "Boosted keyword", "example": "Whippy", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "denoising_mode": { "description": "Agent denoising mode.\n\nCurrently supports:\n * `noise-cancellation`: Reduces background noise and echoes.\n * `noise-and-background-speech-cancellation`: Reduces background noise, echoes, and background speech (e.g. voices from TVs or nearby conversations).\n", "enum": [ "noise-cancellation", "noise-and-background-speech-cancellation" ], "example": "noise-cancellation", "type": "string", "x-struct": null, "x-validate": null }, "enable_backchannel": { "default": false, "description": "Agent backchannel enabled option.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "end_call_after_silence_ms": { "default": 600000, "description": "Agent end call after silence ms setting.\n\nControls the time in milliseconds to end the call when the user is unresponsive. Must be at least 10000.\n", "example": 600000, "minimum": 10000, "type": "integer", "x-struct": null, "x-validate": null }, "fallback_voice_ids": { "description": "Fallback voice IDs to be used in case voice ID isn't available.\n\n**Must be from different TTS provider than voice ID.**\n", "example": [ "openai-Echo" ], "items": { "description": "Fallback voice ID", "example": "openai-Echo", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "interruption_sensitivity": { "default": 1, "description": "Agent interruption sensitivity.\n\nControls how sensitive the agent is to user interruptions. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "language": { "default": "multi", "description": "Agent language.\n\nOnly used for the STT (Speech To Text) model. Use `multi` to enable multilingual operation across all supported languages.\n", "enum": [ "en-US", "en-IN", "en-GB", "de-DE", "es-ES", "es-419", "hi-IN", "ja-JP", "pt-PT", "pt-BR", "fr-FR", "zh-CN", "ru-RU", "it-IT", "ko-KR", "nl-NL", "pl-PL", "tr-TR", "vi-VN", "multi", "en-AU", "en-NZ", "fr-CA", "ro-RO", "bg-BG", "ca-ES", "da-DK", "fi-FI", "el-GR", "hu-HU", "id-ID", "no-NO", "sk-SK", "sv-SE", "nl-BE", "th-TH", "sw-KE" ], "example": "multi", "type": "string", "x-struct": null, "x-validate": null }, "max_call_duration_ms": { "default": 3600000, "description": "Agent max call duration ms setting.\n\nControls the time in milliseconds that a call can take before being automatically terminated. Must be from 60000 to 7200000.\n", "example": 3600000, "maximum": 7200000, "minimum": 60000, "type": "integer", "x-struct": null, "x-validate": null }, "max_chat_duration_ms": { "default": 86400000, "description": "Agent max chat duration ms setting.\n\nControls the time in milliseconds that a chat agent can take before being automatically terminated.\n", "example": 86400000, "type": "integer", "x-struct": null, "x-validate": null }, "normalize_for_speech": { "default": false, "description": "Agent normalize for speech option.\n\nThis feature normalizes the text to it's speech form, e.g. \"The payment is $24.12\" -> \"The payment is twenty four dollars twelve cents\".\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "post_call_analysis_data": { "description": "Post call analysis data to extract from the call for the Agent.\n\n**It's defined as a JSON Schema object.**\n", "example": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "properties": { "$defs": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Definitions of reusable JSON Schema properties that can be referenced using $ref.\n\nEach key/value pair corresponds to a reusable property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "type": "object", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Properties of the JSON Schema.\n\nEach key/value pair corresponds to a property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the JSON Schema.\n\nMust be keys defined in the properties.\n", "example": [], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "description": "Type of the JSON Schema", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, "post_call_analysis_model": { "default": "gpt-5.6-luna", "description": "Agent post call analysis model.\n\nSpecifies the model used for post call analysis to extract structured data from the call.\n", "enum": [ "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5.1", "gpt-5.2", "gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.6-luna", "gpt-5.6-terra", "gpt-5.6-sol", "gpt-6-astra", "gpt-6-sol", "gpt-6-luna", "gpt-6.1-sol", "claude-4.5-haiku", "claude-4.5-sonnet", "claude-4.6-sonnet", "claude-5-sonnet", "claude-5.5-sonnet", "claude-4-7-opus", "claude-4-8-opus", "claude-5-5-opus", "gemini-2.5-flash", "gemini-2.5-flash-lite", "gemini-3.0-flash", "gemini-3.1-flash-lite", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.5-flash-lite", "gemini-3.6-flash", "gemini-3.7-flash", "gemini-3.8-flash", "glm-5.3", "glm-5.3-flash", "deepseek-v4.1-flash", "qwen3.8-max" ], "example": "gpt-5.6-luna", "type": "string", "x-struct": null, "x-validate": null }, "pronunciation_dictionary": { "description": "Agent pronunciation dictionary.\n\nGuides the audio synthesizer for consistent pronunciation.\n", "example": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "items": { "description": "Pronunciation dictionary item", "properties": { "alphabet": { "description": "Phonetic alphabet", "enum": [ "ipa" ], "example": "ipa", "type": "string", "x-struct": null, "x-validate": null }, "phoneme": { "description": "Word in the phonetic alphabet format", "example": "ˈæktʃuəli", "type": "string", "x-struct": null, "x-validate": null }, "word": { "description": "Word or phrase", "example": "actually", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "reminder_max_count": { "default": 1, "description": "Agent reminder max count.\n\nControls how many times the agent will remind the user when user is unresponsive.\n", "example": 1, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "reminder_trigger_ms": { "default": 10000, "description": "Agent reminder trigger ms setting.\n\nControls how long the agent waits, in milliseconds, before reminding an unresponsive user. Must be from 1000 to 30000.\n", "example": 10000, "maximum": 30000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null }, "responsiveness": { "default": 1, "description": "Agent responsiveness.\n\nControls how responsive the agent is. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "stt_mode": { "default": "fast", "description": "Agent speech-to-text (STT) mode.\n\nControls the mode of the speech-to-text engine used for transcribing calls.\n", "enum": [ "fast", "accurate" ], "example": "fast", "type": "string", "x-struct": null, "x-validate": null }, "user_dtmf_options": { "deprecated": true, "description": "Deprecated. Use `allow_user_dtmf` to enable or disable caller keypad input.\n\nConfiguration for user DTMF input, such as digit limit, termination key, and timeout in milliseconds.\n", "example": { "digit_limit": 25, "termination_key": "#", "timeout_ms": 5000 }, "properties": { "digit_limit": { "description": "Maximum number of digits the user can input per turn.\n\nOnce this limit is reached, the input is considered complete and a response will be generated immediately.\n", "example": 25, "maximum": 50, "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "termination_key": { "description": "Single key that terminates DTMF input.", "example": "#", "pattern": "^[0-9#*]$", "type": "string", "x-struct": null, "x-validate": null }, "timeout_ms": { "description": "Timeout in milliseconds for DTMF input.\n\nThe timer resets with each digit received. Must be from 1000 to 15000.\n", "example": 5000, "maximum": 15000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "timeout_ms" ], "type": "object", "x-struct": null, "x-validate": null }, "vocab_specialization": { "default": "general", "description": "Agent vocabulary specialization.\n\nControls the vocabulary specialization used for the agent.\n", "enum": [ "general", "medical" ], "example": "general", "type": "string", "x-struct": null, "x-validate": null }, "voice_id": { "default": "cartesia-Adrian", "description": "Agent voice ID\n\n**Must be from the same provider as the LLM model in case it's a speech-to-speech model.**\n", "example": "cartesia-Adrian", "type": "string", "x-struct": null, "x-validate": null }, "voice_model": { "description": "Agent voice model.\n\nLeave `voice_model` unset or set it to `null` to let Whippy choose the best model.\n\nCurrently supports:\n * `eleven_flash_v2`: English, very fast, good quality (11Labs).\n * `eleven_flash_v2_5`: Multilingual, very fast, good quality (11Labs).\n * `eleven_multilingual_v2`: Multilingual, slow, great quality (11Labs).\n * `eleven_v3`: Multilingual, fast, great quality (11Labs).\n * `eleven_v4`: Multilingual, slowest, best quality.\n * `eleven_v4_turbo`: Multilingual, fastest, great quality.\n * `gpt-4o-mini-tts`: Fast, good quality (OpenAI).\n * `tts-1`: Slow, great quality (OpenAI).\n * `sonic-3`: Fast, good quality (Cartesia).\n\n**Only works with their respective voices respectively.**\n", "enum": [ "sonic-3", "tts-1", "gpt-4o-mini-tts", "eleven_multilingual_v2", "eleven_flash_v2", "eleven_flash_v2_5", "eleven_v3", "eleven_v4", "eleven_v4_turbo" ], "example": "eleven_flash_v2_5", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "voice_speed": { "default": 1, "description": "Agent voice speed.\n\nControls the voice speed of the agent. Must be from 0.5 to 2.\n", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number", "x-struct": null, "x-validate": null }, "voice_temperature": { "default": 1, "description": "Agent voice temperature.\n\nControls how stable the voice of the agent is, from 0 to 2. **Only works with 11labs voices.**\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "voicemail_option": { "default": { "action": { "type": "hangup" } }, "description": "Agent voicemail option.\n\nCurrently supports:\n * `nil`: Disable the voicemail detection.\n * `%{\"action\" => %{\"type\" => \"hangup\"}}`: Hang up the call once a voicemail is detected.\n * `%{\"action\" => %{\"type\" => \"prompt\", \"text\" => prompt}}`: Leaves an AI generated message on the voicemail.\n * `%{\"action\" => %{\"type\" => \"static_text\", \"text\" => message}}`: Leaves a static message on the voicemail.\n\n", "example": { "action": { "type": "hangup" } }, "properties": { "action": { "properties": { "text": { "description": "Text to use for the voicemail.\n\nRequired for `prompt` and `static_text` types. Not used for `hangup` type.\n", "example": "Hello, this is Adrian. Please return the call whenever you're available", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of voicemail action", "enum": [ "hangup", "static_text", "prompt" ], "example": "hangup", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "volume": { "default": 1, "description": "Agent volume.\n\nControls how loud the agent is. Must be from 0 to 2.\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "default_call_flow": { "description": "Agent default call flow", "example": { "color": "#FFA500", "created_by_id": 1, "description": "Call flow from the AI Agent Adrian that forwards the call to him", "emoji": "🤖", "id": "8b67c259-4550-47a7-82b1-4aa1a2428971", "name": "Forward to Agent: Adrian", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "updated_by_id": 1 }, "properties": { "color": { "description": "Call flow color", "example": "#000000", "type": "string", "x-struct": null, "x-validate": null }, "created_by_id": { "description": "User ID that created the call flow", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Call flow description", "example": "Call flow from the AI Agent Adrian that forwards the call to him", "type": "string", "x-struct": null, "x-validate": null }, "emoji": { "description": "Call flow emoji", "example": "🤖", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Call flow ID", "example": "8b67c259-4550-47a7-82b1-4aa1a2428971", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Call flow name", "example": "Forward to Agent: Adrian", "type": "string", "x-struct": null, "x-validate": null }, "organization_id": { "description": "Organization ID that the call flow belongs to", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "updated_by_id": { "description": "User ID that updated the call flow", "example": 1, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "deleted_at": { "description": "Time of deletion of the agent in ISO 8601 format", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "deleted_by": { "description": "Data for the user that deleted the agent", "properties": { "email": { "description": "User email", "example": "carl@gmail.com", "format": "email", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "User ID", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "name": { "description": "User name", "example": "Carl Sagan", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "User phone", "example": "+142481208301", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "draft_version": { "description": "Agent draft version", "example": { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:56:24.260121Z", "created_by_id": 1, "description": "Law Agent", "id": "d2b27b17-65e1-47e8-a434-df60404011c1", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": "Adrian", "notes": "Updated the greeting and escalation instructions", "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "placeholders_filters": {}, "published_at": "2024-04-30T08:56:24Z", "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } }, "nullable": true, "properties": { "agent_id": { "description": "ID of agent that the agent version belongs to", "example": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "description": "Time of creation of the agent version in ISO 8601 format", "example": "2024-04-30T08:56:24.260121Z", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "created_by_id": { "description": "ID of the user that created the agent version", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Agent description", "example": "Law Agent", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Agent version ID", "example": "d2b27b17-65e1-47e8-a434-df60404011c1", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "llm_id": { "description": "ID of the LLM in use by the agent version", "example": "a3698a2e-49ff-482e-abac-261ed384fe69", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Agent name", "example": "Adrian", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Notes about the agent version", "example": "Updated the greeting and escalation instructions", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "organization_id": { "description": "ID of organization that the agent version belongs to", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "placeholders_filters": { "additionalProperties": { "properties": { "filter": { "description": "Filter rules that define which records populate the variable.", "items": { "properties": { "column": { "description": "The column on the resource on which the comparison should be executed.", "example": "status", "type": "string", "x-struct": null, "x-validate": null }, "comparison": { "description": "The comparison operator to use.", "enum": [ "==", "!=", "<", ">", "<=", ">=", "in", "like", "ilike", "not_in", "contains", "not_contains", "is_contained", "not_like", "not_ilike", "ilike_any", "not_ilike_all", "between", "in_radius", "not_in_radius" ], "example": "==", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "The resource on which the filter should be applied.", "example": "job", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Value to compare. Its type depends on the comparison operator.", "example": "active", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "comparison", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "limit": { "description": "Maximum number of records to return for the variable.", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "sort": { "description": "Rules that define how the returned records are sorted.", "items": { "properties": { "column": { "description": "Resource column to sort by.", "example": "created_at", "type": "string", "x-struct": null, "x-validate": null }, "order": { "description": "Sort direction.", "enum": [ "asc", "desc" ], "example": "desc", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "Resource to sort.", "example": "job", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "order" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "filter" ], "type": "object", "x-struct": null, "x-validate": null }, "description": "User-defined variables populated by filtering records with Whippy Query Language (WQL).\n\nEach key is a variable name, such as `available_jobs`. Its value contains the `filter` rules that define which\nrecords populate the variable and may also contain `limit` and `sort`.\n\nAt runtime, Whippy filters records for the current contact and, where applicable, the current agent, then makes\nthe results available in the agent instructions:\n\n * `{{@repeat available_jobs}}...{{@endrepeat}}` repeats the enclosed content for each matching record.\n Fields within the repeated content can use placeholders such as `{{custom.job.title}}`.\n * `{{@if available_jobs}}...{{@else}}...{{@endif}}` renders the first block when records match, or the\n optional `@else` block when none match.\n", "example": { "available_jobs": { "filter": [ { "column": "status", "comparison": "==", "resource": "job", "value": "active" } ], "limit": 10, "sort": [ { "column": "created_at", "order": "desc", "resource": "job" } ] } }, "type": "object", "x-struct": null, "x-validate": null }, "published_at": { "description": "Time the agent version was published in ISO 8601 format", "example": "2024-04-30T08:56:24Z", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "settings": { "additionalProperties": false, "description": "Agent settings", "properties": { "allow_user_dtmf": { "default": true, "description": "Agent allow user DTMF option.\n\nControls whether the agent allows the user to input DTMF (Dual-tone multi-frequency) signals (e.g., pressing keys on the phone keypad) during the call.\n", "example": true, "type": "boolean", "x-struct": null, "x-validate": null }, "ambient_sound": { "description": "Agent ambient environment sound", "enum": [ "coffee-shop", "convention-hall", "summer-outdoor", "mountain-outdoor", "static-noise", "call-center" ], "example": "coffee-shop", "type": "string", "x-struct": null, "x-validate": null }, "ambient_sound_volume": { "default": 1, "description": "Agent ambient environment sound volume, from 0 to 2.", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_frequency": { "default": 0.8, "description": "Agent backchannel frequency.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement. Must be from 0 to 1.\n", "example": 0.8, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_words": { "description": "Agent backchannel words.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": [ "okay", "uh-huh", "mhmm", "yah" ], "items": { "description": "Backchannel word", "example": "okay", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "begin_message_delay_ms": { "default": 0, "description": "Agent begin message delay ms setting.\n\nControls the time in milliseconds that the agent will wait once the call starts before saying the begin message. Must be from 0 to 5000.\n", "example": 0, "maximum": 5000, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "boosted_keywords": { "description": "Agent boosted keywords to bias the STT (Speech To Text) model.\n\nCommonly used for names, brands, street, etc.\n", "example": [ "Whippy" ], "items": { "description": "Boosted keyword", "example": "Whippy", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "denoising_mode": { "description": "Agent denoising mode.\n\nCurrently supports:\n * `noise-cancellation`: Reduces background noise and echoes.\n * `noise-and-background-speech-cancellation`: Reduces background noise, echoes, and background speech (e.g. voices from TVs or nearby conversations).\n", "enum": [ "noise-cancellation", "noise-and-background-speech-cancellation" ], "example": "noise-cancellation", "type": "string", "x-struct": null, "x-validate": null }, "enable_backchannel": { "default": false, "description": "Agent backchannel enabled option.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "end_call_after_silence_ms": { "default": 600000, "description": "Agent end call after silence ms setting.\n\nControls the time in milliseconds to end the call when the user is unresponsive. Must be at least 10000.\n", "example": 600000, "minimum": 10000, "type": "integer", "x-struct": null, "x-validate": null }, "fallback_voice_ids": { "description": "Fallback voice IDs to be used in case voice ID isn't available.\n\n**Must be from different TTS provider than voice ID.**\n", "example": [ "openai-Echo" ], "items": { "description": "Fallback voice ID", "example": "openai-Echo", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "interruption_sensitivity": { "default": 1, "description": "Agent interruption sensitivity.\n\nControls how sensitive the agent is to user interruptions. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "language": { "default": "multi", "description": "Agent language.\n\nOnly used for the STT (Speech To Text) model. Use `multi` to enable multilingual operation across all supported languages.\n", "enum": [ "en-US", "en-IN", "en-GB", "de-DE", "es-ES", "es-419", "hi-IN", "ja-JP", "pt-PT", "pt-BR", "fr-FR", "zh-CN", "ru-RU", "it-IT", "ko-KR", "nl-NL", "pl-PL", "tr-TR", "vi-VN", "multi", "en-AU", "en-NZ", "fr-CA", "ro-RO", "bg-BG", "ca-ES", "da-DK", "fi-FI", "el-GR", "hu-HU", "id-ID", "no-NO", "sk-SK", "sv-SE", "nl-BE", "th-TH", "sw-KE" ], "example": "multi", "type": "string", "x-struct": null, "x-validate": null }, "max_call_duration_ms": { "default": 3600000, "description": "Agent max call duration ms setting.\n\nControls the time in milliseconds that a call can take before being automatically terminated. Must be from 60000 to 7200000.\n", "example": 3600000, "maximum": 7200000, "minimum": 60000, "type": "integer", "x-struct": null, "x-validate": null }, "max_chat_duration_ms": { "default": 86400000, "description": "Agent max chat duration ms setting.\n\nControls the time in milliseconds that a chat agent can take before being automatically terminated.\n", "example": 86400000, "type": "integer", "x-struct": null, "x-validate": null }, "normalize_for_speech": { "default": false, "description": "Agent normalize for speech option.\n\nThis feature normalizes the text to it's speech form, e.g. \"The payment is $24.12\" -> \"The payment is twenty four dollars twelve cents\".\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "post_call_analysis_data": { "description": "Post call analysis data to extract from the call for the Agent.\n\n**It's defined as a JSON Schema object.**\n", "example": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "properties": { "$defs": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Definitions of reusable JSON Schema properties that can be referenced using $ref.\n\nEach key/value pair corresponds to a reusable property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "type": "object", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Properties of the JSON Schema.\n\nEach key/value pair corresponds to a property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the JSON Schema.\n\nMust be keys defined in the properties.\n", "example": [], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "description": "Type of the JSON Schema", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, "post_call_analysis_model": { "default": "gpt-5.6-luna", "description": "Agent post call analysis model.\n\nSpecifies the model used for post call analysis to extract structured data from the call.\n", "enum": [ "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5.1", "gpt-5.2", "gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.6-luna", "gpt-5.6-terra", "gpt-5.6-sol", "gpt-6-astra", "gpt-6-sol", "gpt-6-luna", "gpt-6.1-sol", "claude-4.5-haiku", "claude-4.5-sonnet", "claude-4.6-sonnet", "claude-5-sonnet", "claude-5.5-sonnet", "claude-4-7-opus", "claude-4-8-opus", "claude-5-5-opus", "gemini-2.5-flash", "gemini-2.5-flash-lite", "gemini-3.0-flash", "gemini-3.1-flash-lite", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.5-flash-lite", "gemini-3.6-flash", "gemini-3.7-flash", "gemini-3.8-flash", "glm-5.3", "glm-5.3-flash", "deepseek-v4.1-flash", "qwen3.8-max" ], "example": "gpt-5.6-luna", "type": "string", "x-struct": null, "x-validate": null }, "pronunciation_dictionary": { "description": "Agent pronunciation dictionary.\n\nGuides the audio synthesizer for consistent pronunciation.\n", "example": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "items": { "description": "Pronunciation dictionary item", "properties": { "alphabet": { "description": "Phonetic alphabet", "enum": [ "ipa" ], "example": "ipa", "type": "string", "x-struct": null, "x-validate": null }, "phoneme": { "description": "Word in the phonetic alphabet format", "example": "ˈæktʃuəli", "type": "string", "x-struct": null, "x-validate": null }, "word": { "description": "Word or phrase", "example": "actually", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "reminder_max_count": { "default": 1, "description": "Agent reminder max count.\n\nControls how many times the agent will remind the user when user is unresponsive.\n", "example": 1, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "reminder_trigger_ms": { "default": 10000, "description": "Agent reminder trigger ms setting.\n\nControls how long the agent waits, in milliseconds, before reminding an unresponsive user. Must be from 1000 to 30000.\n", "example": 10000, "maximum": 30000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null }, "responsiveness": { "default": 1, "description": "Agent responsiveness.\n\nControls how responsive the agent is. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "stt_mode": { "default": "fast", "description": "Agent speech-to-text (STT) mode.\n\nControls the mode of the speech-to-text engine used for transcribing calls.\n", "enum": [ "fast", "accurate" ], "example": "fast", "type": "string", "x-struct": null, "x-validate": null }, "user_dtmf_options": { "deprecated": true, "description": "Deprecated. Use `allow_user_dtmf` to enable or disable caller keypad input.\n\nConfiguration for user DTMF input, such as digit limit, termination key, and timeout in milliseconds.\n", "example": { "digit_limit": 25, "termination_key": "#", "timeout_ms": 5000 }, "properties": { "digit_limit": { "description": "Maximum number of digits the user can input per turn.\n\nOnce this limit is reached, the input is considered complete and a response will be generated immediately.\n", "example": 25, "maximum": 50, "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "termination_key": { "description": "Single key that terminates DTMF input.", "example": "#", "pattern": "^[0-9#*]$", "type": "string", "x-struct": null, "x-validate": null }, "timeout_ms": { "description": "Timeout in milliseconds for DTMF input.\n\nThe timer resets with each digit received. Must be from 1000 to 15000.\n", "example": 5000, "maximum": 15000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "timeout_ms" ], "type": "object", "x-struct": null, "x-validate": null }, "vocab_specialization": { "default": "general", "description": "Agent vocabulary specialization.\n\nControls the vocabulary specialization used for the agent.\n", "enum": [ "general", "medical" ], "example": "general", "type": "string", "x-struct": null, "x-validate": null }, "voice_id": { "default": "cartesia-Adrian", "description": "Agent voice ID\n\n**Must be from the same provider as the LLM model in case it's a speech-to-speech model.**\n", "example": "cartesia-Adrian", "type": "string", "x-struct": null, "x-validate": null }, "voice_model": { "description": "Agent voice model.\n\nLeave `voice_model` unset or set it to `null` to let Whippy choose the best model.\n\nCurrently supports:\n * `eleven_flash_v2`: English, very fast, good quality (11Labs).\n * `eleven_flash_v2_5`: Multilingual, very fast, good quality (11Labs).\n * `eleven_multilingual_v2`: Multilingual, slow, great quality (11Labs).\n * `eleven_v3`: Multilingual, fast, great quality (11Labs).\n * `eleven_v4`: Multilingual, slowest, best quality.\n * `eleven_v4_turbo`: Multilingual, fastest, great quality.\n * `gpt-4o-mini-tts`: Fast, good quality (OpenAI).\n * `tts-1`: Slow, great quality (OpenAI).\n * `sonic-3`: Fast, good quality (Cartesia).\n\n**Only works with their respective voices respectively.**\n", "enum": [ "sonic-3", "tts-1", "gpt-4o-mini-tts", "eleven_multilingual_v2", "eleven_flash_v2", "eleven_flash_v2_5", "eleven_v3", "eleven_v4", "eleven_v4_turbo" ], "example": "eleven_flash_v2_5", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "voice_speed": { "default": 1, "description": "Agent voice speed.\n\nControls the voice speed of the agent. Must be from 0.5 to 2.\n", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number", "x-struct": null, "x-validate": null }, "voice_temperature": { "default": 1, "description": "Agent voice temperature.\n\nControls how stable the voice of the agent is, from 0 to 2. **Only works with 11labs voices.**\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "voicemail_option": { "default": { "action": { "type": "hangup" } }, "description": "Agent voicemail option.\n\nCurrently supports:\n * `nil`: Disable the voicemail detection.\n * `%{\"action\" => %{\"type\" => \"hangup\"}}`: Hang up the call once a voicemail is detected.\n * `%{\"action\" => %{\"type\" => \"prompt\", \"text\" => prompt}}`: Leaves an AI generated message on the voicemail.\n * `%{\"action\" => %{\"type\" => \"static_text\", \"text\" => message}}`: Leaves a static message on the voicemail.\n\n", "example": { "action": { "type": "hangup" } }, "properties": { "action": { "properties": { "text": { "description": "Text to use for the voicemail.\n\nRequired for `prompt` and `static_text` types. Not used for `hangup` type.\n", "example": "Hello, this is Adrian. Please return the call whenever you're available", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of voicemail action", "enum": [ "hangup", "static_text", "prompt" ], "example": "hangup", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "volume": { "default": 1, "description": "Agent volume.\n\nControls how loud the agent is. Must be from 0 to 2.\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Agent ID", "example": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "organization": { "description": "Data for the organization that the agent belongs to", "example": { "id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "name": "Hello Inc." }, "properties": { "id": { "description": "Organization ID", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Organization name", "example": "Hello Inc.", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "status": { "description": "Agent status", "enum": [ "draft", "active", "archived", "deleted" ], "example": "archived", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "Time of the last update of the agent in ISO 8601 format", "example": "2024-01-06T12:19:39Z", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "updated_by": { "description": "Data for the user that updated the agent", "example": { "email": "carl@gmail.com", "id": 1, "name": "Carl Sagan", "phone": "+142481208301" }, "properties": { "email": { "description": "User email", "example": "carl@gmail.com", "format": "email", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "User ID", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "name": { "description": "User name", "example": "Carl Sagan", "type": "string", "x-struct": null, "x-validate": null }, "phone": { "description": "User phone", "example": "+142481208301", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "usage_mode": { "description": "Usage mode of the Agent", "enum": [ "ai_minutes", "completed_calls" ], "example": "ai_minutes", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "versions": { "description": "Data for the agent versions that belongs to the agent", "example": [ { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:52:17.493485Z", "created_by_id": 1, "description": null, "id": "dd9e1aff-9818-4117-9929-b83bff5a5c57", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": null, "notes": null, "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "published_at": null, "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } } ], "items": { "description": "Agent version record", "example": { "agent_id": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "created_at": "2024-04-30T08:52:17.493485Z", "created_by_id": 1, "description": null, "id": "dd9e1aff-9818-4117-9929-b83bff5a5c57", "llm_id": "a3698a2e-49ff-482e-abac-261ed384fe69", "name": null, "notes": null, "organization_id": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "published_at": null, "settings": { "allow_user_dtmf": true, "ambient_sound": null, "ambient_sound_volume": 1, "backchannel_frequency": 0.8, "backchannel_words": null, "begin_message_delay_ms": 0, "boosted_keywords": null, "denoising_mode": "noise-cancellation", "enable_backchannel": false, "end_call_after_silence_ms": 600000, "fallback_voice_ids": null, "interruption_sensitivity": 1, "language": "multi", "max_call_duration_ms": 3600000, "max_chat_duration_ms": 86400000, "normalize_for_speech": false, "post_call_analysis_data": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "post_call_analysis_model": "gpt-5.6-luna", "pronunciation_dictionary": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "reminder_max_count": 1, "reminder_trigger_ms": 10000, "responsiveness": 1, "stt_mode": "fast", "vocab_specialization": "general", "voice_id": "cartesia-Adrian", "voice_model": "sonic-3", "voice_speed": 1, "voice_temperature": 1, "voicemail_option": { "action": { "type": "hangup" } }, "volume": 1 } }, "properties": { "agent_id": { "description": "ID of agent that the agent version belongs to", "example": "e177be99-c879-4ee9-bf63-d49f3eebe90c", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "description": "Time of creation of the agent version in ISO 8601 format", "example": "2024-04-30T08:56:24.260121Z", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "created_by_id": { "description": "ID of the user that created the agent version", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "Agent description", "example": "Law Agent", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "Agent version ID", "example": "d2b27b17-65e1-47e8-a434-df60404011c1", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "llm_id": { "description": "ID of the LLM in use by the agent version", "example": "a3698a2e-49ff-482e-abac-261ed384fe69", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Agent name", "example": "Adrian", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Notes about the agent version", "example": "Updated the greeting and escalation instructions", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "organization_id": { "description": "ID of organization that the agent version belongs to", "example": "7b5e5482-0bac-4d6b-942c-b7adff4fc5b6", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "placeholders_filters": { "additionalProperties": { "properties": { "filter": { "description": "Filter rules that define which records populate the variable.", "items": { "properties": { "column": { "description": "The column on the resource on which the comparison should be executed.", "example": "status", "type": "string", "x-struct": null, "x-validate": null }, "comparison": { "description": "The comparison operator to use.", "enum": [ "==", "!=", "<", ">", "<=", ">=", "in", "like", "ilike", "not_in", "contains", "not_contains", "is_contained", "not_like", "not_ilike", "ilike_any", "not_ilike_all", "between", "in_radius", "not_in_radius" ], "example": "==", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "The resource on which the filter should be applied.", "example": "job", "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Value to compare. Its type depends on the comparison operator.", "example": "active", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "comparison", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "limit": { "description": "Maximum number of records to return for the variable.", "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "sort": { "description": "Rules that define how the returned records are sorted.", "items": { "properties": { "column": { "description": "Resource column to sort by.", "example": "created_at", "type": "string", "x-struct": null, "x-validate": null }, "order": { "description": "Sort direction.", "enum": [ "asc", "desc" ], "example": "desc", "type": "string", "x-struct": null, "x-validate": null }, "resource": { "description": "Resource to sort.", "example": "job", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "resource", "column", "order" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "filter" ], "type": "object", "x-struct": null, "x-validate": null }, "description": "User-defined variables populated by filtering records with Whippy Query Language (WQL).\n\nEach key is a variable name, such as `available_jobs`. Its value contains the `filter` rules that define which\nrecords populate the variable and may also contain `limit` and `sort`.\n\nAt runtime, Whippy filters records for the current contact and, where applicable, the current agent, then makes\nthe results available in the agent instructions:\n\n * `{{@repeat available_jobs}}...{{@endrepeat}}` repeats the enclosed content for each matching record.\n Fields within the repeated content can use placeholders such as `{{custom.job.title}}`.\n * `{{@if available_jobs}}...{{@else}}...{{@endif}}` renders the first block when records match, or the\n optional `@else` block when none match.\n", "example": { "available_jobs": { "filter": [ { "column": "status", "comparison": "==", "resource": "job", "value": "active" } ], "limit": 10, "sort": [ { "column": "created_at", "order": "desc", "resource": "job" } ] } }, "type": "object", "x-struct": null, "x-validate": null }, "published_at": { "description": "Time the agent version was published in ISO 8601 format", "example": "2024-04-30T08:56:24Z", "format": "date-time", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "settings": { "additionalProperties": false, "description": "Agent settings", "properties": { "allow_user_dtmf": { "default": true, "description": "Agent allow user DTMF option.\n\nControls whether the agent allows the user to input DTMF (Dual-tone multi-frequency) signals (e.g., pressing keys on the phone keypad) during the call.\n", "example": true, "type": "boolean", "x-struct": null, "x-validate": null }, "ambient_sound": { "description": "Agent ambient environment sound", "enum": [ "coffee-shop", "convention-hall", "summer-outdoor", "mountain-outdoor", "static-noise", "call-center" ], "example": "coffee-shop", "type": "string", "x-struct": null, "x-validate": null }, "ambient_sound_volume": { "default": 1, "description": "Agent ambient environment sound volume, from 0 to 2.", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_frequency": { "default": 0.8, "description": "Agent backchannel frequency.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement. Must be from 0 to 1.\n", "example": 0.8, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "backchannel_words": { "description": "Agent backchannel words.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": [ "okay", "uh-huh", "mhmm", "yah" ], "items": { "description": "Backchannel word", "example": "okay", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "begin_message_delay_ms": { "default": 0, "description": "Agent begin message delay ms setting.\n\nControls the time in milliseconds that the agent will wait once the call starts before saying the begin message. Must be from 0 to 5000.\n", "example": 0, "maximum": 5000, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "boosted_keywords": { "description": "Agent boosted keywords to bias the STT (Speech To Text) model.\n\nCommonly used for names, brands, street, etc.\n", "example": [ "Whippy" ], "items": { "description": "Boosted keyword", "example": "Whippy", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "denoising_mode": { "description": "Agent denoising mode.\n\nCurrently supports:\n * `noise-cancellation`: Reduces background noise and echoes.\n * `noise-and-background-speech-cancellation`: Reduces background noise, echoes, and background speech (e.g. voices from TVs or nearby conversations).\n", "enum": [ "noise-cancellation", "noise-and-background-speech-cancellation" ], "example": "noise-cancellation", "type": "string", "x-struct": null, "x-validate": null }, "enable_backchannel": { "default": false, "description": "Agent backchannel enabled option.\n\nBackchannel is when the agent interjects the speaker with phrases like \"yeah\", \"uh-huh\" to signify interest and engagement.\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "end_call_after_silence_ms": { "default": 600000, "description": "Agent end call after silence ms setting.\n\nControls the time in milliseconds to end the call when the user is unresponsive. Must be at least 10000.\n", "example": 600000, "minimum": 10000, "type": "integer", "x-struct": null, "x-validate": null }, "fallback_voice_ids": { "description": "Fallback voice IDs to be used in case voice ID isn't available.\n\n**Must be from different TTS provider than voice ID.**\n", "example": [ "openai-Echo" ], "items": { "description": "Fallback voice ID", "example": "openai-Echo", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "interruption_sensitivity": { "default": 1, "description": "Agent interruption sensitivity.\n\nControls how sensitive the agent is to user interruptions. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "language": { "default": "multi", "description": "Agent language.\n\nOnly used for the STT (Speech To Text) model. Use `multi` to enable multilingual operation across all supported languages.\n", "enum": [ "en-US", "en-IN", "en-GB", "de-DE", "es-ES", "es-419", "hi-IN", "ja-JP", "pt-PT", "pt-BR", "fr-FR", "zh-CN", "ru-RU", "it-IT", "ko-KR", "nl-NL", "pl-PL", "tr-TR", "vi-VN", "multi", "en-AU", "en-NZ", "fr-CA", "ro-RO", "bg-BG", "ca-ES", "da-DK", "fi-FI", "el-GR", "hu-HU", "id-ID", "no-NO", "sk-SK", "sv-SE", "nl-BE", "th-TH", "sw-KE" ], "example": "multi", "type": "string", "x-struct": null, "x-validate": null }, "max_call_duration_ms": { "default": 3600000, "description": "Agent max call duration ms setting.\n\nControls the time in milliseconds that a call can take before being automatically terminated. Must be from 60000 to 7200000.\n", "example": 3600000, "maximum": 7200000, "minimum": 60000, "type": "integer", "x-struct": null, "x-validate": null }, "max_chat_duration_ms": { "default": 86400000, "description": "Agent max chat duration ms setting.\n\nControls the time in milliseconds that a chat agent can take before being automatically terminated.\n", "example": 86400000, "type": "integer", "x-struct": null, "x-validate": null }, "normalize_for_speech": { "default": false, "description": "Agent normalize for speech option.\n\nThis feature normalizes the text to it's speech form, e.g. \"The payment is $24.12\" -> \"The payment is twenty four dollars twelve cents\".\n", "example": false, "type": "boolean", "x-struct": null, "x-validate": null }, "post_call_analysis_data": { "description": "Post call analysis data to extract from the call for the Agent.\n\n**It's defined as a JSON Schema object.**\n", "example": { "properties": { "experience_in_years": { "description": "User's years of experience at the job", "type": "integer" }, "method": { "description": "User's preferred contact method", "enum": [ "sms", "phone", "email" ], "type": "string" }, "overtime": { "description": "User's availability to work overtime", "type": "boolean" }, "user_email": { "description": "User's email address for contacting purposes", "examples": [ "john.wayne@whippy.co", "jonnyw@google.com" ], "format": "email", "type": "string" } }, "required": [ "user_email", "method", "overtime", "experience_in_years" ], "type": "object" }, "properties": { "$defs": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Definitions of reusable JSON Schema properties that can be referenced using $ref.\n\nEach key/value pair corresponds to a reusable property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "type": "object", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": { "oneOf": [ { "description": "String type JSON Schema property", "properties": { "default": { "description": "Default value of the string property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the string property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed string property values", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the string property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "format": { "description": "Format of the string property", "enum": [ "date-time", "time", "date", "duration", "email", "hostname", "ipv4", "ipv6", "uuid" ], "example": "email", "type": "string", "x-struct": null, "x-validate": null }, "pattern": { "description": "Pattern of the string property", "example": "^@[a-zA-Z0-9_]+$", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the string property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "string" ], "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Boolean type JSON Schema property", "properties": { "default": { "description": "Default value of the boolean property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed boolean property values", "items": { "type": "boolean", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the boolean property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the boolean property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "boolean" ], "example": "boolean", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Integer type JSON Schema property", "properties": { "default": { "description": "Default value of the integer property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed integer property values", "items": { "type": "integer", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the integer property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the integer property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "integer" ], "example": "integer", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Number type JSON Schema property", "properties": { "default": { "description": "Default value of the number property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the number property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed number property values", "items": { "type": "number", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the number property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "exclusiveMaximum": { "description": "Exclusive maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "exclusiveMinimum": { "description": "Exclusive minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "maximum": { "description": "Maximum value of the number property", "example": 100, "type": "number", "x-struct": null, "x-validate": null }, "minimum": { "description": "Minimum value of the number property", "example": 0, "type": "number", "x-struct": null, "x-validate": null }, "multipleOf": { "description": "Allowed 'multiple of' value for the number property", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the number property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "number" ], "example": "number", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Null type JSON Schema property", "properties": { "default": { "description": "Default value of the null property", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the null property", "type": "string", "x-struct": null, "x-validate": null }, "enum": { "description": "Enumeration of allowed null property values", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the null property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the null property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "null" ], "example": "null", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Array type JSON Schema property", "properties": { "default": { "description": "Default value for the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the array property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the array property", "items": { "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "items": { "description": "Schema for items in the array property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "maxItems": { "description": "Maximum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "minItems": { "description": "Minimum number of items in the array", "type": "integer", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the array property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "array" ], "example": "array", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "items" ], "type": "object", "x-struct": null, "x-validate": null }, { "description": "Object type JSON Schema property", "properties": { "default": { "description": "Default value for the object property", "type": "object", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the object property", "type": "string", "x-struct": null, "x-validate": null }, "examples": { "description": "Examples of the object property", "items": { "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "properties": { "additionalProperties": true, "description": "Properties of the object property.\n\nEach key/value pair corresponds to a property that can be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Any of\n- Reference\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the object property", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "title": { "description": "Title of the object property", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of property per JSON Schema definition", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Any of JSON Schema property", "properties": { "anyOf": { "description": "Schemas for the any of JSON Schema property.", "items": { "description": "Schema for the any of JSON Schema property.\n\nCan be any of:\n- String\n- Boolean\n- Integer\n- Number\n- Object\n- Array\n- Reference\n", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "anyOf" ], "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Reference JSON Schema property", "properties": { "$ref": { "description": "Reference to a JSON Schema definition", "example": "#/$defs/my_schema", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "$ref" ], "type": "object", "x-struct": null, "x-validate": null } ], "x-struct": null, "x-validate": null }, "description": "Properties of the JSON Schema.\n\nEach key/value pair corresponds to a property.\n- **It's validated against all defined types and their properties.**\n- **It supports additional JSON Schema definitions outside the AI Agent's `post_call_analysis_data`.**\n", "x-struct": null, "x-validate": null }, "required": { "description": "Required properties of the JSON Schema.\n\nMust be keys defined in the properties.\n", "example": [], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "description": "Type of the JSON Schema", "enum": [ "object" ], "example": "object", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "properties", "required" ], "type": "object", "x-struct": null, "x-validate": null }, "post_call_analysis_model": { "default": "gpt-5.6-luna", "description": "Agent post call analysis model.\n\nSpecifies the model used for post call analysis to extract structured data from the call.\n", "enum": [ "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5.1", "gpt-5.2", "gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.6-luna", "gpt-5.6-terra", "gpt-5.6-sol", "gpt-6-astra", "gpt-6-sol", "gpt-6-luna", "gpt-6.1-sol", "claude-4.5-haiku", "claude-4.5-sonnet", "claude-4.6-sonnet", "claude-5-sonnet", "claude-5.5-sonnet", "claude-4-7-opus", "claude-4-8-opus", "claude-5-5-opus", "gemini-2.5-flash", "gemini-2.5-flash-lite", "gemini-3.0-flash", "gemini-3.1-flash-lite", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.5-flash-lite", "gemini-3.6-flash", "gemini-3.7-flash", "gemini-3.8-flash", "glm-5.3", "glm-5.3-flash", "deepseek-v4.1-flash", "qwen3.8-max" ], "example": "gpt-5.6-luna", "type": "string", "x-struct": null, "x-validate": null }, "pronunciation_dictionary": { "description": "Agent pronunciation dictionary.\n\nGuides the audio synthesizer for consistent pronunciation.\n", "example": [ { "alphabet": "ipa", "phoneme": "ˈæktʃuəli", "word": "actually" } ], "items": { "description": "Pronunciation dictionary item", "properties": { "alphabet": { "description": "Phonetic alphabet", "enum": [ "ipa" ], "example": "ipa", "type": "string", "x-struct": null, "x-validate": null }, "phoneme": { "description": "Word in the phonetic alphabet format", "example": "ˈæktʃuəli", "type": "string", "x-struct": null, "x-validate": null }, "word": { "description": "Word or phrase", "example": "actually", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "reminder_max_count": { "default": 1, "description": "Agent reminder max count.\n\nControls how many times the agent will remind the user when user is unresponsive.\n", "example": 1, "minimum": 0, "type": "integer", "x-struct": null, "x-validate": null }, "reminder_trigger_ms": { "default": 10000, "description": "Agent reminder trigger ms setting.\n\nControls how long the agent waits, in milliseconds, before reminding an unresponsive user. Must be from 1000 to 30000.\n", "example": 10000, "maximum": 30000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null }, "responsiveness": { "default": 1, "description": "Agent responsiveness.\n\nControls how responsive the agent is. Must be from 0 to 1.\n", "example": 1, "maximum": 1, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "stt_mode": { "default": "fast", "description": "Agent speech-to-text (STT) mode.\n\nControls the mode of the speech-to-text engine used for transcribing calls.\n", "enum": [ "fast", "accurate" ], "example": "fast", "type": "string", "x-struct": null, "x-validate": null }, "user_dtmf_options": { "deprecated": true, "description": "Deprecated. Use `allow_user_dtmf` to enable or disable caller keypad input.\n\nConfiguration for user DTMF input, such as digit limit, termination key, and timeout in milliseconds.\n", "example": { "digit_limit": 25, "termination_key": "#", "timeout_ms": 5000 }, "properties": { "digit_limit": { "description": "Maximum number of digits the user can input per turn.\n\nOnce this limit is reached, the input is considered complete and a response will be generated immediately.\n", "example": 25, "maximum": 50, "minimum": 1, "type": "integer", "x-struct": null, "x-validate": null }, "termination_key": { "description": "Single key that terminates DTMF input.", "example": "#", "pattern": "^[0-9#*]$", "type": "string", "x-struct": null, "x-validate": null }, "timeout_ms": { "description": "Timeout in milliseconds for DTMF input.\n\nThe timer resets with each digit received. Must be from 1000 to 15000.\n", "example": 5000, "maximum": 15000, "minimum": 1000, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "timeout_ms" ], "type": "object", "x-struct": null, "x-validate": null }, "vocab_specialization": { "default": "general", "description": "Agent vocabulary specialization.\n\nControls the vocabulary specialization used for the agent.\n", "enum": [ "general", "medical" ], "example": "general", "type": "string", "x-struct": null, "x-validate": null }, "voice_id": { "default": "cartesia-Adrian", "description": "Agent voice ID\n\n**Must be from the same provider as the LLM model in case it's a speech-to-speech model.**\n", "example": "cartesia-Adrian", "type": "string", "x-struct": null, "x-validate": null }, "voice_model": { "description": "Agent voice model.\n\nLeave `voice_model` unset or set it to `null` to let Whippy choose the best model.\n\nCurrently supports:\n * `eleven_flash_v2`: English, very fast, good quality (11Labs).\n * `eleven_flash_v2_5`: Multilingual, very fast, good quality (11Labs).\n * `eleven_multilingual_v2`: Multilingual, slow, great quality (11Labs).\n * `eleven_v3`: Multilingual, fast, great quality (11Labs).\n * `eleven_v4`: Multilingual, slowest, best quality.\n * `eleven_v4_turbo`: Multilingual, fastest, great quality.\n * `gpt-4o-mini-tts`: Fast, good quality (OpenAI).\n * `tts-1`: Slow, great quality (OpenAI).\n * `sonic-3`: Fast, good quality (Cartesia).\n\n**Only works with their respective voices respectively.**\n", "enum": [ "sonic-3", "tts-1", "gpt-4o-mini-tts", "eleven_multilingual_v2", "eleven_flash_v2", "eleven_flash_v2_5", "eleven_v3", "eleven_v4", "eleven_v4_turbo" ], "example": "eleven_flash_v2_5", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "voice_speed": { "default": 1, "description": "Agent voice speed.\n\nControls the voice speed of the agent. Must be from 0.5 to 2.\n", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number", "x-struct": null, "x-validate": null }, "voice_temperature": { "default": 1, "description": "Agent voice temperature.\n\nControls how stable the voice of the agent is, from 0 to 2. **Only works with 11labs voices.**\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null }, "voicemail_option": { "default": { "action": { "type": "hangup" } }, "description": "Agent voicemail option.\n\nCurrently supports:\n * `nil`: Disable the voicemail detection.\n * `%{\"action\" => %{\"type\" => \"hangup\"}}`: Hang up the call once a voicemail is detected.\n * `%{\"action\" => %{\"type\" => \"prompt\", \"text\" => prompt}}`: Leaves an AI generated message on the voicemail.\n * `%{\"action\" => %{\"type\" => \"static_text\", \"text\" => message}}`: Leaves a static message on the voicemail.\n\n", "example": { "action": { "type": "hangup" } }, "properties": { "action": { "properties": { "text": { "description": "Text to use for the voicemail.\n\nRequired for `prompt` and `static_text` types. Not used for `hangup` type.\n", "example": "Hello, this is Adrian. Please return the call whenever you're available", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of voicemail action", "enum": [ "hangup", "static_text", "prompt" ], "example": "hangup", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "volume": { "default": 1, "description": "Agent volume.\n\nControls how loud the agent is. Must be from 0 to 2.\n", "example": 1, "maximum": 2, "minimum": 0, "type": "number", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "ShowAgentResponse", "type": "object", "x-struct": null, "x-validate": null }, "BadRequest": { "description": "Bad request error response", "example": { "errors": [ { "description": "events must be an array" } ] }, "properties": { "errors": { "items": { "properties": { "description": { "description": "Error description", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": "Elixir.DashboardApiWeb.Public.V1.Documentation.Errors.BadRequest", "x-validate": null }, "AgentNotFoundErrorResponse": { "description": "Response that occurs when the agent record doesn't exist", "example": { "errors": [ { "description": "Agent not found" } ], "status": 404 }, "properties": { "errors": { "description": "Agent 404 error", "items": { "description": "Single 404 error", "properties": { "description": { "enum": [ "Agent not found" ], "example": "Agent not found", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "enum": [ 404 ], "example": 404, "type": "integer", "x-struct": null, "x-validate": null } }, "title": "AgentNotFoundErrorResponse", "type": "object", "x-struct": null, "x-validate": null }, "ForbiddenErrorResponse": { "description": "Forbidden Error Response schema", "example": { "error": "Token does not have the required scope for this action." }, "properties": { "error": { "description": "Stable public error message for insufficient OAuth scope", "example": "Token does not have the required scope for this action.", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "error" ], "title": "ForbiddenErrorResponse", "type": "object", "x-struct": "Elixir.DashboardApiWeb.Public.V1.Documentation.Errors.Forbidden", "x-validate": null }, "AgentUnprocessableContentErrorResponse": { "description": "List of error responses for invalid agent GET or POST requests.", "example": { "errors": [ { "description": "Name is invalid" } ], "status": 422 }, "properties": { "errors": { "description": "Agent 422 errors", "items": { "description": "Single 422 error", "properties": { "description": { "description": "Human-readable explanation of the invalid request.", "example": "Agent must exist", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "enum": [ 422 ], "example": 422, "type": "integer", "x-struct": null, "x-validate": null } }, "title": "AgentUnprocessableContentErrorResponse", "type": "object", "x-struct": null, "x-validate": null } }, "securitySchemes": { "authorization": { "in": "header", "name": "X-WHIPPY-KEY", "type": "apiKey" }, "bearer": { "description": "OAuth Access token", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Whippy Public API.\n\n## Authentication\n\nThe Whippy Public API supports two authentication methods:\n\n**API Key** — Generate an organization API token and send it with every request as the `X-WHIPPY-KEY` header.\n\n**OAuth Bearer Token** — Obtain an access token via the OAuth authorization flow and send it as a Bearer token in the `Authorization` header (e.g. `Authorization: Bearer `).\n\n## Rate Limiting\n\nThe Whippy API is rate limited. Different endpoints have different rate limits.\nEach request to the API will return the following headers, which can be used to keep track of your rate limit status:\n * `x-ratelimit-max`: The maximum number of requests that the consumer is permitted to make in the given time period.\n * `x-ratelimit-remaining`: The number of requests remaining in the current rate limit window.\n * `x-ratelimit-interval-milliseconds`: The rate limit window in milliseconds.\n * `x-ratelimit-remaining-interval-milliseconds`: The time in milliseconds until the rate limit window resets.\n", "title": "Whippy Public API", "version": "1.0" }, "openapi": "3.0.0", "paths": { "/v1/agents/{id}": { "delete": { "callbacks": {}, "deprecated": false, "description": "Deletes an agent that belongs to the authenticated organization.", "operationId": "deleteAgent", "parameters": [ { "description": "Agent ID", "example": "f083f63d-45e0-47f4-a03d-177a77f45b5d", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowAgentResponse" } } }, "description": "Delete Agent Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthenticatedErrorResponse" } } }, "description": "Not Authenticated" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentNotFoundErrorResponse" } } }, "description": "Agent Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUnprocessableContentErrorResponse" } } }, "description": "Unprocessable Content" } }, "security": [ { "authorization": [] }, { "bearer": [] } ], "summary": "Delete Agent", "tags": [ "Agent" ] } } }, "security": [], "servers": [ { "url": "https://api.whippy.co", "variables": {} } ] } ```