--- title: "List Scenarios" method: GET path: "/eval/simulation/scenario" tags: ["Simulation Scenarios"] --- # List Scenarios `GET /eval/simulation/scenario` ## Query parameters - `idAny` string[] - `name` string - `page` number - `sortOrder` 'ASC' | 'DESC' - `sortBy` 'createdAt' | 'duration' | 'cost' - `limit` number - `createdAtGt` string, date-time - `createdAtLt` string, date-time - `createdAtGe` string, date-time - `createdAtLe` string, date-time - `updatedAtGt` string, date-time - `updatedAtLt` string, date-time - `updatedAtGe` string, date-time - `updatedAtLe` string, date-time ## Response `200` - Scenario[] - `id` string, uuid, required — This is the unique identifier for the scenario. - `orgId` string, uuid, required — This is the unique identifier for the organization this scenario belongs to. - `createdAt` string, date-time, required — This is the ISO 8601 date-time string of when the scenario was created. - `updatedAt` string, date-time, required — This is the ISO 8601 date-time string of when the scenario was last updated. - `name` string, required — This is the name of the scenario. - `instructions` string, required — This is the script/instructions for the tester to follow during the simulation. - `evaluations` EvaluationPlanItem[], required — This is the structured output-based evaluation plan for the simulation. Each item defines a structured output to extract and evaluate against an expected value. - `structuredOutputId` string, uuid — This is the ID of an existing structured output to use for evaluation. Mutually exclusive with structuredOutput. - `structuredOutput` CreateStructuredOutputDTO - `type` 'ai' | 'regex' — This is the type of structured output. - 'ai': Uses an LLM to extract structured data from the conversation (default). - 'regex': Uses a regex pattern to extract data from the transcript without an LLM. Defaults to 'ai' if not specified. - `regex` string — This is the regex pattern to match against the transcript. Only used when type is 'regex'. Supports both raw patterns (e.g. '\d+') and regex literal format (e.g. '/\d+/gi'). Uses RE2 syntax for safety. The result depends on the schema type: - boolean: true if the pattern matches, false otherwise - string: the first match or first capture group - number/integer: the first match parsed as a number - array: all matches - `model` union — This is the model that will be used to extract the structured output. To provide your own custom system and user prompts for structured output extraction, populate the messages array with your system and user messages. You can specify liquid templating in your system and user messages. Between the system or user messages, you must reference either 'transcript' or 'messages' with the `{{}}` syntax to access the conversation history. Between the system or user messages, you must reference a variation of the structured output with the `{{}}` syntax to access the structured output definition. i.e.: `{{structuredOutput}}` `{{structuredOutput.name}}` `{{structuredOutput.description}}` `{{structuredOutput.schema}}` If model is not specified, GPT-4.1 will be used by default for extraction, utilizing default system and user prompts. If messages or required fields are not specified, the default system and user prompts will be used. - WorkflowOpenAIModel - `messages` OpenAIMessage[] — These are the messages used to customize the prompt used for structured output extraction. When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. If not provided, default system and user prompts are used. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `provider` 'openai', required — This is the provider of the model (`openai`). - `model` 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'chat-latest' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.2' | 'gpt-5.2-chat-latest' | 'gpt-5.1' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-chat-latest' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'chatgpt-4o-latest' | 'o3' | 'o3-mini' | 'o4-mini' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-5.6-luna:westus3' | 'gpt-5.6-terra:westus3' | 'gpt-5.6-sol:westus3' | 'gpt-5.4:eastus2' | 'gpt-5.4:swedencentral' | 'gpt-5.4-mini:eastus2' | 'gpt-5.4-mini:swedencentral' | 'gpt-5.4-nano:eastus2' | 'gpt-5.4-nano:swedencentral' | 'gpt-5.2:eastus2' | 'gpt-5.2:swedencentral' | 'gpt-5.1:eastus2' | 'gpt-5.1:swedencentral' | 'gpt-5:eastus2' | 'gpt-5:swedencentral' | 'gpt-5:canadaeast' | 'gpt-5:eastus' | 'gpt-5:westeurope' | 'gpt-5:germanywestcentral' | 'gpt-5:polandcentral' | 'gpt-5:spaincentral' | 'gpt-5-mini:eastus2' | 'gpt-5-mini:swedencentral' | 'gpt-5-mini:westeurope' | 'gpt-5-mini:germanywestcentral' | 'gpt-5-mini:polandcentral' | 'gpt-5-mini:spaincentral' | 'gpt-5-nano:eastus2' | 'gpt-5-nano:swedencentral' | 'gpt-4.1-2025-04-14:westus' | 'gpt-4.1-2025-04-14:eastus2' | 'gpt-4.1-2025-04-14:eastus' | 'gpt-4.1-2025-04-14:westus3' | 'gpt-4.1-2025-04-14:northcentralus' | 'gpt-4.1-2025-04-14:southcentralus' | 'gpt-4.1-2025-04-14:westeurope' | 'gpt-4.1-2025-04-14:germanywestcentral' | 'gpt-4.1-2025-04-14:polandcentral' | 'gpt-4.1-2025-04-14:spaincentral' | 'gpt-4.1-mini-2025-04-14:westus' | 'gpt-4.1-mini-2025-04-14:eastus2' | 'gpt-4.1-mini-2025-04-14:eastus' | 'gpt-4.1-mini-2025-04-14:westus3' | 'gpt-4.1-mini-2025-04-14:northcentralus' | 'gpt-4.1-mini-2025-04-14:southcentralus' | 'gpt-4.1-mini-2025-04-14:westeurope' | 'gpt-4.1-mini-2025-04-14:germanywestcentral' | 'gpt-4.1-mini-2025-04-14:polandcentral' | 'gpt-4.1-mini-2025-04-14:spaincentral' | 'gpt-4.1-nano-2025-04-14:westus' | 'gpt-4.1-nano-2025-04-14:eastus2' | 'gpt-4.1-nano-2025-04-14:westus3' | 'gpt-4.1-nano-2025-04-14:northcentralus' | 'gpt-4.1-nano-2025-04-14:southcentralus' | 'gpt-4o-2024-11-20:swedencentral' | 'gpt-4o-2024-11-20:westus' | 'gpt-4o-2024-11-20:eastus2' | 'gpt-4o-2024-11-20:eastus' | 'gpt-4o-2024-11-20:westus3' | 'gpt-4o-2024-11-20:southcentralus' | 'gpt-4o-2024-11-20:westeurope' | 'gpt-4o-2024-11-20:germanywestcentral' | 'gpt-4o-2024-11-20:polandcentral' | 'gpt-4o-2024-11-20:spaincentral' | 'gpt-4o-2024-08-06:westus' | 'gpt-4o-2024-08-06:westus3' | 'gpt-4o-2024-08-06:eastus' | 'gpt-4o-2024-08-06:eastus2' | 'gpt-4o-2024-08-06:northcentralus' | 'gpt-4o-2024-08-06:southcentralus' | 'gpt-4o-mini-2024-07-18:westus' | 'gpt-4o-mini-2024-07-18:westus3' | 'gpt-4o-mini-2024-07-18:eastus' | 'gpt-4o-mini-2024-07-18:eastus2' | 'gpt-4o-mini-2024-07-18:northcentralus' | 'gpt-4o-mini-2024-07-18:southcentralus' | 'gpt-4o-2024-05-13:eastus2' | 'gpt-4o-2024-05-13:eastus' | 'gpt-4o-2024-05-13:northcentralus' | 'gpt-4o-2024-05-13:southcentralus' | 'gpt-4o-2024-05-13:westus3' | 'gpt-4o-2024-05-13:westus' | 'gpt-4-turbo-2024-04-09:eastus2' | 'gpt-4-0125-preview:eastus' | 'gpt-4-0125-preview:northcentralus' | 'gpt-4-0125-preview:southcentralus' | 'gpt-4-1106-preview:australiaeast' | 'gpt-4-1106-preview:canadaeast' | 'gpt-4-1106-preview:france' | 'gpt-4-1106-preview:india' | 'gpt-4-1106-preview:norway' | 'gpt-4-1106-preview:swedencentral' | 'gpt-4-1106-preview:uk' | 'gpt-4-1106-preview:westus' | 'gpt-4-1106-preview:westus3' | 'gpt-4-0613:canadaeast' | 'gpt-3.5-turbo-0125:canadaeast' | 'gpt-3.5-turbo-0125:northcentralus' | 'gpt-3.5-turbo-0125:southcentralus' | 'gpt-3.5-turbo-1106:canadaeast' | 'gpt-3.5-turbo-1106:westus' | 'gpt-4.1:australiaeast' | 'gpt-4o:australiaeast' | 'gpt-5.4-mini:australiaeast', required — This is the OpenAI model that will be used. When using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense. This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/. - `temperature` number — This is the temperature of the model. - `maxTokens` number — This is the max tokens of the model. - WorkflowAnthropicModel - `messages` OpenAIMessage[] — These are the messages used to customize the prompt used for structured output extraction. When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. If not provided, default system and user prompts are used. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `provider` 'anthropic', required — This is the provider of the model (`anthropic`). - `model` 'claude-3-opus-20240229' | 'claude-3-sonnet-20240229' | 'claude-3-haiku-20240307' | 'claude-3-5-sonnet-20240620' | 'claude-3-5-sonnet-20241022' | 'claude-3-5-haiku-20241022' | 'claude-3-7-sonnet-20250219' | 'claude-opus-4-20250514' | 'claude-opus-4-5-20251101' | 'claude-opus-4-6' | 'claude-sonnet-4-20250514' | 'claude-sonnet-4-5-20250929' | 'claude-sonnet-4-6' | 'claude-sonnet-5' | 'claude-haiku-4-5-20251001', required — This is the specific model that will be used. - `thinking` AnthropicThinkingConfig - `type` 'enabled', required - `budgetTokens` number, required — The maximum number of tokens to allocate for thinking. Must be between 1024 and 100000 tokens. - `temperature` number — This is the temperature of the model. - `maxTokens` number — This is the max tokens of the model. - WorkflowAnthropicBedrockModel - `messages` OpenAIMessage[] — These are the messages used to customize the prompt used for structured output extraction. When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. If not provided, default system and user prompts are used. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `provider` 'anthropic-bedrock', required — This is the provider of the model (`anthropic-bedrock`). - `model` 'claude-3-opus-20240229' | 'claude-3-sonnet-20240229' | 'claude-3-haiku-20240307' | 'claude-3-5-sonnet-20240620' | 'claude-3-5-sonnet-20241022' | 'claude-3-5-haiku-20241022' | 'claude-3-7-sonnet-20250219' | 'claude-opus-4-20250514' | 'claude-opus-4-5-20251101' | 'claude-opus-4-6' | 'claude-sonnet-4-20250514' | 'claude-sonnet-4-5-20250929' | 'claude-sonnet-4-6' | 'claude-haiku-4-5-20251001' | 'global.anthropic.claude-haiku-4-5-20251001-v1:0', required — This is the specific model that will be used. - `thinking` AnthropicThinkingConfig - `type` 'enabled', required - `budgetTokens` number, required — The maximum number of tokens to allocate for thinking. Must be between 1024 and 100000 tokens. - `temperature` number — This is the temperature of the model. - `maxTokens` number — This is the max tokens of the model. - WorkflowGoogleModel - `messages` OpenAIMessage[] — These are the messages used to customize the prompt used for structured output extraction. When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. If not provided, default system and user prompts are used. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `provider` 'google', required — This is the provider of the model (`google`). - `model` 'gemini-3.5-flash' | 'gemini-3.1-flash-lite' | 'gemini-3-flash-preview' | 'gemini-2.5-pro' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-2.0-flash-thinking-exp' | 'gemini-2.0-pro-exp-02-05' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.0-flash-exp' | 'gemini-2.0-flash-realtime-exp' | 'gemini-1.5-flash' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature of the model. - `maxTokens` number — This is the max tokens of the model. - WorkflowCustomModel - `messages` OpenAIMessage[] — These are the messages used to customize the prompt used for structured output extraction. When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. If not provided, default system and user prompts are used. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `provider` 'custom-llm', required — This is the provider of the model (`custom-llm`). - `metadataSendMode` 'off' | 'variable' | 'destructured' — This determines whether metadata is sent in requests to the custom provider. - `off` will not send any metadata. payload will look like `{ messages }` - `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }` - `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }` Further, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload. Default is `variable`. - `url` string, required — These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 - `headers` object — These are the headers we'll use for the OpenAI client's `headers`. - `timeoutSeconds` number — This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds. - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature of the model. - `maxTokens` number — This is the max tokens of the model. - `compliancePlan` ComplianceOverride - `forceStoreOnHipaaEnabled` boolean — Force storage for this output under HIPAA. Only enable if output contains no sensitive data. - `conditions` union[], nullable — These are the conditions that gate the execution of this structured output. Every condition must pass for the structured output to run (AND semantics). When omitted or empty, no user-defined conditions gate this output. Send null to clear a previously saved gate. - union - MinMessagesCondition - `type` 'minMessages', required — This is the type discriminator for the minMessages condition. - `count` number, required — This is the minimum number of conversation messages required for the structured output to run. A count of 0 removes the runtime default minimum, so the structured output runs regardless of how few messages the conversation has. - MinCallDurationCondition - `type` 'minCallDuration', required — This is the type discriminator for the minCallDuration condition. - `seconds` number, required — This is the minimum call duration in seconds required for the structured output to run. When timestamps are unavailable (for example, chat sessions have no call timestamps), this check passes and does not block the structured output. - EndedReasonCondition - `type` 'endedReason', required — This is the type discriminator for the endedReason condition. - `operator` 'oneOf' | 'notOneOf', required — This is the membership operator applied against `values`. - 'oneOf': the structured output runs only if the call's ended reason is in `values`. - 'notOneOf': the structured output runs only if the call's ended reason is NOT in `values`. - `values` string[], required — These are the ended reasons compared against the call's ended reason. Any string is accepted so configurations never break when new ended reasons are introduced. Must contain at least one value. - `name` string, required — This is the name of the structured output. - `schema` JsonSchema, required - `type` 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object', required — This is the type of output you'd like. `string`, `number`, `integer`, `boolean` are the primitive types and should be obvious. `array` and `object` are more interesting and quite powerful. They allow you to define nested structures. For `array`, you can define the schema of the items in the array using the `items` property. For `object`, you can define the properties of the object using the `properties` property. - `items` JsonSchema — recursive - `properties` object — This is required if the type is "object". This specifies the properties of the object. This is a map of property names to JsonSchema objects. - `description` string — This is the description to help the model understand what it needs to output. - `pattern` string — This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead. OpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties - `format` 'date-time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uuid' — This is the format of the string. To pass a regex, use the `pattern` property instead. OpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat&type-restrictions=string-restrictions - `required` string[] — This is a list of properties that are required. This only makes sense if the type is "object". - `enum` string[] — This array specifies the allowed values that can be used to restrict the output of the model. - `title` string — This is the title of the schema. - `description` string — This is the description of what the structured output extracts. Use this to provide context about what data will be extracted and how it will be used. - `assistantIds` string[] — These are the assistant IDs that this structured output is linked to. When linked to assistants, this structured output will be available for extraction during those assistant's calls. - `workflowIds` string[] — These are the workflow IDs that this structured output is linked to. When linked to workflows, this structured output will be available for extraction during those workflow's execution. - `path` string — Optional dot-notation path to a primitive leaf when evaluating an object structured output. - `comparator` '=' | '!=' | '>' | '<' | '>=' | '<=', required — This is the comparison operator to use when evaluating the extracted value against the expected value. Available operators depend on the structured output's schema type: - boolean: '=', '!=' - string: '=', '!=' - number/integer: '=', '!=', '>', '<', '>=', '<=' - `value` union, required — This is the expected value to compare against the extracted structured output result. Type should match the structured output's schema type. - number - string - boolean - `required` boolean — This is whether this evaluation must pass for the simulation to pass. Defaults to true. If false, the result is informational only. - `hooks` union[] — Hooks to run on simulation lifecycle events - union - SimulationHookCallStarted - `on` 'simulation.run.started', required - `do` SimulationHookWebhookAction[], required - `type` 'webhook', required - `server` Server - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `include` SimulationHookInclude - `transcript` boolean — Include transcript in the hook payload - `messages` boolean — Include messages in the hook payload - `recordingUrl` boolean — Include recordingUrl in the hook payload - SimulationHookCallEnded - `on` 'simulation.run.ended', required - `do` SimulationHookWebhookAction[], required - `type` 'webhook', required - `server` Server - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `include` SimulationHookInclude - `transcript` boolean — Include transcript in the hook payload - `messages` boolean — Include messages in the hook payload - `recordingUrl` boolean — Include recordingUrl in the hook payload - `targetOverrides` AssistantOverrides - `transcriber` union — These are the options for the assistant's transcriber. - AssemblyAITranscriber - `provider` 'assembly-ai', required — This is the transcription provider that will be used. - `language` 'multi' | 'en' — This is the language that will be set for the transcription. - `confidenceThreshold` number — Transcripts below this confidence threshold will be discarded. @default 0.4 - `formatTurns` boolean — This enables formatting of transcripts. @default true - `endOfTurnConfidenceThreshold` number — This is the end of turn confidence threshold. The minimum confidence that the end of turn is detected. Note: Only used if startSpeakingPlan.smartEndpointingPlan is not set. @min 0 @max 1 @default 0.7 - `minEndOfTurnSilenceWhenConfident` number — This is the minimum end of turn silence when confident in milliseconds. Note: Only used if startSpeakingPlan.smartEndpointingPlan is not set. @default 160 - `wordFinalizationMaxWaitTime` number - `maxTurnSilence` number — This is the maximum turn silence time in milliseconds. Note: Only used if startSpeakingPlan.smartEndpointingPlan is not set. @default 400 - `vadAssistedEndpointingEnabled` boolean — Use VAD to assist with endpointing decisions from the transcriber. When enabled, transcriber endpointing will be buffered if VAD detects the user is still speaking, preventing premature turn-taking. When disabled, transcriber endpointing will be used immediately regardless of VAD state, allowing for quicker but more aggressive turn-taking. Note: Only used if startSpeakingPlan.smartEndpointingPlan is not set. @default true - `mode` 'max_accuracy' | 'min_latency' | 'balanced' — This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model. @default 'balanced' - `prompt` string — This is a prompt that provides additional context to the transcription model. Only applies to the `universal-3-5-pro` speech model. - `agentContext` string — This is context about the voice agent that guides the transcription model. Only applies to the `universal-3-5-pro` speech model. - `languageCodes` string[] — These are language codes used to steer automatic language detection. Only applies to the `universal-3-5-pro` speech model. - `speechModel` 'universal-streaming-english' | 'universal-streaming-multilingual' | 'universal-3-5-pro' — This is the speech model used for the streaming session. Keyterms prompting is supported on universal-streaming-english and universal-3-5-pro. universal-3-5-pro is AssemblyAI's most accurate voice-agent model. @default 'universal-streaming-english' - `realtimeUrl` string — The WebSocket URL that the transcriber connects to. - `wordBoost` string[] — Add up to 2500 characters of custom vocabulary. - `keytermsPrompt` string[] — Keyterms prompting improves recognition accuracy for specific words and phrases. Can include up to 100 keyterms, each up to 50 characters. Costs an additional $0.04/hour on universal-streaming-english and is included at no extra cost on universal-3-5-pro. - `endUtteranceSilenceThreshold` number — The duration of the end utterance silence threshold in milliseconds. - `disablePartialTranscripts` boolean — Disable partial transcripts. Set to `true` to not receive partial transcripts. Defaults to `false`. - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - AzureSpeechTranscriber - `provider` 'azure', required — This is the transcription provider that will be used. - `language` 'af-ZA' | 'am-ET' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IL' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-PS' | 'ar-QA' | 'ar-SA' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'az-AZ' | 'bg-BG' | 'bn-IN' | 'bs-BA' | 'ca-ES' | 'cs-CZ' | 'cy-GB' | 'da-DK' | 'de-AT' | 'de-CH' | 'de-DE' | 'el-GR' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-GH' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-KE' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-SG' | 'en-TZ' | 'en-US' | 'en-ZA' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et-EE' | 'eu-ES' | 'fa-IR' | 'fi-FI' | 'fil-PH' | 'fr-BE' | 'fr-CA' | 'fr-CH' | 'fr-FR' | 'ga-IE' | 'gl-ES' | 'gu-IN' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'hy-AM' | 'id-ID' | 'is-IS' | 'it-CH' | 'it-IT' | 'ja-JP' | 'jv-ID' | 'ka-GE' | 'kk-KZ' | 'km-KH' | 'kn-IN' | 'ko-KR' | 'lo-LA' | 'lt-LT' | 'lv-LV' | 'mk-MK' | 'ml-IN' | 'mn-MN' | 'mr-IN' | 'ms-MY' | 'mt-MT' | 'my-MM' | 'nb-NO' | 'ne-NP' | 'nl-BE' | 'nl-NL' | 'pa-IN' | 'pl-PL' | 'ps-AF' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'si-LK' | 'sk-SK' | 'sl-SI' | 'so-SO' | 'sq-AL' | 'sr-RS' | 'sv-SE' | 'sw-KE' | 'sw-TZ' | 'ta-IN' | 'te-IN' | 'th-TH' | 'tr-TR' | 'uk-UA' | 'ur-IN' | 'uz-UZ' | 'vi-VN' | 'wuu-CN' | 'yue-CN' | 'zh-CN' | 'zh-CN-shandong' | 'zh-CN-sichuan' | 'zh-HK' | 'zh-TW' | 'zu-ZA' — This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt - `segmentationStrategy` 'Default' | 'Time' | 'Semantic' — Controls how phrase boundaries are detected, enabling either simple time/silence heuristics or more advanced semantic segmentation. - `segmentationSilenceTimeoutMs` number — Duration of detected silence after which the service finalizes a phrase. Configure to adjust sensitivity to pauses in speech. - `segmentationMaximumTimeMs` number — Maximum duration a segment can reach before being cut off when using time-based segmentation. - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - CustomTranscriber - `provider` 'custom-transcriber', required — This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - `type` object, required — This is the type of backoff plan to use. Defaults to fixed. @default fixed - `maxRetries` number, required — This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries). @default 0 - `baseDelaySeconds` number, required — This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay. - `excludedStatusCodes` object[] — This is the excluded status codes. If the response status code is in this list, the request will not be retried. By default, the request will be retried for any non-2xx status code. - … - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - DeepgramTranscriber - `provider` 'deepgram', required — This is the transcription provider that will be used. - `model` union — This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview - 'nova-3' | 'nova-3-general' | 'nova-3-medical' | 'nova-2' | 'nova-2-general' | 'nova-2-meeting' | 'nova-2-phonecall' | 'nova-2-finance' | 'nova-2-conversationalai' | 'nova-2-voicemail' | 'nova-2-video' | 'nova-2-medical' | 'nova-2-drivethru' | 'nova-2-automotive' | 'nova' | 'nova-general' | 'nova-phonecall' | 'nova-medical' | 'enhanced' | 'enhanced-general' | 'enhanced-meeting' | 'enhanced-phonecall' | 'enhanced-finance' | 'base' | 'base-general' | 'base-meeting' | 'base-phonecall' | 'base-finance' | 'base-conversationalai' | 'base-voicemail' | 'base-video' | 'whisper' | 'flux-general-en' | 'flux-general-multi' - string - `language` 'ar' | 'az' | 'ba' | 'be' | 'bg' | 'bn' | 'br' | 'bs' | 'ca' | 'cs' | 'da' | 'da-DK' | 'de' | 'de-CH' | 'el' | 'en' | 'en-AU' | 'en-CA' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-NZ' | 'en-US' | 'es' | 'es-419' | 'es-LATAM' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'fr-CA' | 'ha' | 'haw' | 'he' | 'hi' | 'hi-Latn' | 'hr' | 'hu' | 'id' | 'is' | 'it' | 'ja' | 'jw' | 'kn' | 'ko' | 'ko-KR' | 'ln' | 'lt' | 'lv' | 'mk' | 'mr' | 'ms' | 'multi' | 'nl' | 'nl-BE' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'pt-PT' | 'ro' | 'ru' | 'sk' | 'sl' | 'sn' | 'so' | 'sr' | 'su' | 'sv' | 'sv-SE' | 'ta' | 'taq' | 'te' | 'th' | 'th-TH' | 'tl' | 'tr' | 'tt' | 'uk' | 'ur' | 'vi' | 'yo' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hant' | 'zh-TW' — This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview - `smartFormat` boolean — This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better. - `mipOptOut` boolean — If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out This will only be used if you are using your own Deepgram API key. @default false - `numerals` boolean — If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, "my phone number is nine-seven-two..." would become "my phone number is 972..." @default false - `profanityFilter` boolean — If set to true, Deepgram will replace profanity in transcripts with surrounding asterisks, e.g. "f***". @default false - `redaction` string[] — Enables redaction of sensitive information from transcripts. Options include: - "pci": Redacts credit card numbers, expiration dates, and CVV. - "pii": Redacts personally identifiable information (names, locations, identifying numbers, etc.). - "phi": Redacts protected health information (medical conditions, drugs, injuries, etc.). - "numbers": Redacts numerical and identifying entities (dates, account numbers, SSNs, etc.). Multiple values can be provided to redact different categories simultaneously. Redacted content is replaced with entity labels like [CREDIT_CARD_1], [SSN_1], etc. See https://developers.deepgram.com/docs/redaction for details. - `confidenceThreshold` number — Transcripts below this confidence threshold will be discarded. @default 0.4 - `eotThreshold` number — End-of-turn confidence required to finish a turn. Only used with Flux models. @default 0.7 - `eotTimeoutMs` number — A turn will be finished when this much time has passed after speech, regardless of EOT confidence. Only used with Flux models. @default 5000 - `languages` string[] — Language hints to bias Flux Multilingual (`flux-general-multi`) toward specific languages. Provide BCP-47 language codes (e.g. "en", "es", "fr"). Multiple hints can be given for multilingual or code-switching scenarios. Omit for auto-detection. Only used with `flux-general-multi`. - `keywords` string[] — These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here. - `keyterm` string[] — Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%. - `endpointing` number — This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing. Here are the most important bits: - Defaults to 10. This is recommended for most use cases to optimize for latency. - 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better. - If neither 10 nor 300 work, contact support@vapi.ai and we'll find another solution. @default 10 - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - ElevenLabsTranscriber - `provider` '11labs', required — This is the transcription provider that will be used. - `model` 'scribe_v1' | 'scribe_v2' | 'scribe_v2_realtime' — This is the model that will be used for the transcription. - `language` 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yue' | 'yo' | 'za' | 'zh' | 'zu' — This is the language that will be used for the transcription. - `silenceThresholdSeconds` number — This is the number of seconds of silence before VAD commits (0.3-3.0). - `confidenceThreshold` number — This is the VAD sensitivity (0.1-0.9, lower indicates more sensitive). - `minSpeechDurationMs` number — This is the minimum speech duration for VAD (50-2000ms). - `minSilenceDurationMs` number — This is the minimum silence duration for VAD (50-2000ms). - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - GladiaTranscriber - `provider` 'gladia', required — This is the transcription provider that will be used. - `model` 'fast' | 'accurate' | 'solaria-1' — This is the Gladia model that will be used. Default is 'fast' - `languageBehaviour` 'manual' | 'automatic single language' | 'automatic multiple languages' — Defines how the transcription model detects the audio language. Default value is 'automatic single language'. - `language` 'af' | 'sq' | 'am' | 'ar' | 'hy' | 'as' | 'az' | 'ba' | 'eu' | 'be' | 'bn' | 'bs' | 'br' | 'bg' | 'ca' | 'zh' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fo' | 'fi' | 'fr' | 'gl' | 'ka' | 'de' | 'el' | 'gu' | 'ht' | 'ha' | 'haw' | 'he' | 'hi' | 'hu' | 'is' | 'id' | 'it' | 'ja' | 'jv' | 'kn' | 'kk' | 'km' | 'ko' | 'lo' | 'la' | 'lv' | 'ln' | 'lt' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'mi' | 'mr' | 'mn' | 'my' | 'ne' | 'no' | 'nn' | 'oc' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'ro' | 'ru' | 'sa' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'es' | 'su' | 'sw' | 'sv' | 'tl' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'tr' | 'tk' | 'uk' | 'ur' | 'uz' | 'vi' | 'cy' | 'yi' | 'yo' — Defines the language to use for the transcription. Required when languageBehaviour is 'manual'. - `languages` string[] — Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'. - `transcriptionHint` string — Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored. ⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit. - `prosody` boolean — If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false. - `audioEnhancer` boolean — If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false. - `confidenceThreshold` number — Transcripts below this confidence threshold will be discarded. @default 0.4 - `endpointing` number — Endpointing time in seconds - time to wait before considering speech ended - `speechThreshold` number — Speech threshold - sensitivity configuration for speech detection (0.0 to 1.0) - `customVocabularyEnabled` boolean — Enable custom vocabulary for improved accuracy - `customVocabularyConfig` GladiaCustomVocabularyConfigDTO - `vocabulary` union[], required — Array of vocabulary items (strings or objects with value, pronunciations, intensity, language) - union - … - `defaultIntensity` number — Default intensity for vocabulary items (0.0 to 1.0) - `region` 'us-west' | 'eu-west' — Region for processing audio (us-west or eu-west) - `receivePartialTranscripts` boolean — Enable partial transcripts for low-latency streaming transcription - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - GoogleTranscriber - `provider` 'google', required — This is the transcription provider that will be used. - `model` 'gemini-3.5-flash' | 'gemini-3.1-flash-lite' | 'gemini-3-flash-preview' | 'gemini-2.5-pro' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-2.0-flash-thinking-exp' | 'gemini-2.0-pro-exp-02-05' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.0-flash-exp' | 'gemini-2.0-flash-realtime-exp' | 'gemini-1.5-flash' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro' — This is the model that will be used for the transcription. - `language` 'Multilingual' | 'Arabic' | 'Bengali' | 'Bulgarian' | 'Chinese' | 'Croatian' | 'Czech' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Finnish' | 'French' | 'German' | 'Greek' | 'Hebrew' | 'Hindi' | 'Hungarian' | 'Indonesian' | 'Italian' | 'Japanese' | 'Korean' | 'Latvian' | 'Lithuanian' | 'Norwegian' | 'Polish' | 'Portuguese' | 'Romanian' | 'Russian' | 'Serbian' | 'Slovak' | 'Slovenian' | 'Spanish' | 'Swahili' | 'Swedish' | 'Thai' | 'Turkish' | 'Ukrainian' | 'Vietnamese' — This is the language that will be set for the transcription. - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - SpeechmaticsTranscriber - `provider` 'speechmatics', required — This is the transcription provider that will be used. - `model` 'default' — This is the model that will be used for the transcription. - `language` 'auto' | 'ar' | 'ar_en' | 'ba' | 'eu' | 'be' | 'bn' | 'bg' | 'yue' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'eo' | 'et' | 'fi' | 'fr' | 'gl' | 'de' | 'el' | 'he' | 'hi' | 'hu' | 'id' | 'ia' | 'ga' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'en_ms' | 'mt' | 'cmn' | 'cmn_en' | 'mr' | 'mn' | 'no' | 'fa' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'es' | 'en_es' | 'sw' | 'sv' | 'tl' | 'ta' | 'en_ta' | 'th' | 'tr' | 'uk' | 'ur' | 'ug' | 'vi' | 'cy' - `operatingPoint` 'standard' | 'enhanced' — This is the operating point for the transcription. Choose between `standard` for faster turnaround with strong accuracy or `enhanced` for highest accuracy when precision is critical. @default 'enhanced' - `region` 'eu' | 'us' — This is the region for the Speechmatics API. Choose between EU (Europe) and US (United States) regions for lower latency and data sovereignty compliance. @default 'eu' - `enableDiarization` boolean — This enables speaker diarization, which identifies and separates speakers in the transcription. Essential for multi-speaker conversations and conference calls. @default false - `maxDelay` number — This sets the maximum delay in milliseconds for partial transcripts. Balances latency and accuracy. @default 3000 - `customVocabulary` SpeechmaticsCustomVocabularyItem[], required - `content` string, required — The word or phrase to add to the custom vocabulary. - `soundsLike` string[] — Alternative phonetic representations of how the word might sound. This helps recognition when the word might be pronounced differently. - `numeralStyle` 'written' | 'spoken' — This controls how numbers, dates, currencies, and other entities are formatted in the transcription output. @default 'written' - `endOfTurnSensitivity` number — This is the sensitivity level for end-of-turn detection, which determines when a speaker has finished talking. Higher values are more sensitive. @default 0.5 - `removeDisfluencies` boolean — This enables removal of disfluencies (um, uh) from the transcript to create cleaner, more professional output. This is only supported for the English language transcriber. @default false - `minimumSpeechDuration` number — This is the minimum duration in seconds for speech segments. Shorter segments will be filtered out. Helps remove noise and improve accuracy. @default 0.0 - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - TalkscriberTranscriber - `provider` 'talkscriber', required — This is the transcription provider that will be used. - `model` 'whisper' — This is the model that will be used for the transcription. - `language` 'en' | 'zh' | 'de' | 'es' | 'ru' | 'ko' | 'fr' | 'ja' | 'pt' | 'tr' | 'pl' | 'ca' | 'nl' | 'ar' | 'sv' | 'it' | 'id' | 'hi' | 'fi' | 'vi' | 'he' | 'uk' | 'el' | 'ms' | 'cs' | 'ro' | 'da' | 'hu' | 'ta' | 'no' | 'th' | 'ur' | 'hr' | 'bg' | 'lt' | 'la' | 'mi' | 'ml' | 'cy' | 'sk' | 'te' | 'fa' | 'lv' | 'bn' | 'sr' | 'az' | 'sl' | 'kn' | 'et' | 'mk' | 'br' | 'eu' | 'is' | 'hy' | 'ne' | 'mn' | 'bs' | 'kk' | 'sq' | 'sw' | 'gl' | 'mr' | 'pa' | 'si' | 'km' | 'sn' | 'yo' | 'so' | 'af' | 'oc' | 'ka' | 'be' | 'tg' | 'sd' | 'gu' | 'am' | 'yi' | 'lo' | 'uz' | 'fo' | 'ht' | 'ps' | 'tk' | 'nn' | 'mt' | 'sa' | 'lb' | 'my' | 'bo' | 'tl' | 'mg' | 'as' | 'tt' | 'haw' | 'ln' | 'ha' | 'ba' | 'jw' | 'su' | 'yue' — This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - OpenAITranscriber - `provider` 'openai', required — This is the transcription provider that will be used. - `model` 'gpt-4o-transcribe' | 'gpt-4o-mini-transcribe', required — This is the model that will be used for the transcription. - `language` 'af' | 'ar' | 'hy' | 'az' | 'be' | 'bs' | 'bg' | 'ca' | 'zh' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'gl' | 'de' | 'el' | 'he' | 'hi' | 'hu' | 'is' | 'id' | 'it' | 'ja' | 'kn' | 'kk' | 'ko' | 'lv' | 'lt' | 'mk' | 'ms' | 'mr' | 'mi' | 'ne' | 'no' | 'fa' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'tl' | 'ta' | 'th' | 'tr' | 'uk' | 'ur' | 'vi' | 'cy' — This is the language that will be set for the transcription. - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - CartesiaTranscriber - `provider` 'cartesia', required - `model` 'ink-whisper' | 'ink-2' - `language` 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yue' | 'yo' | 'za' | 'zh' | 'zu' - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - SonioxTranscriber - `provider` 'soniox', required - `model` 'stt-rt-v4' | 'stt-rt-v5' — The Soniox model to use for transcription. - `language` 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yue' | 'yo' | 'za' | 'zh' | 'zu' — Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). For multi-language hints or to enable Soniox auto-detect, use `languages` instead — when `languages` is set (including to an empty array), this field is ignored when building the Soniox request. Defaults to `en` if neither this nor `languages` is set. - `languages` string[] — Language hints sent to Soniox as `language_hints`. Provide `[lang1, lang2, ...]` (ISO 639-1 codes) to bias recognition toward specific languages, or provide an explicit empty array `[]` to enable Soniox auto-detect across all 60+ supported languages. When set (including the empty array), this field takes precedence over the singular `language` field. When omitted, falls back to the singular `language` (which defaults to `en` if also unset). Best accuracy is achieved with a single language. - `languageHintsStrict` boolean — When `true`, Soniox strictly restricts transcription to the languages in `languages` (or the singular `language` if `languages` is unset). When `false`, Soniox biases toward those languages but still allows transcription in other languages. Has no effect when no language hints are sent (e.g., `languages: []` for auto-detect). Defaults to `true` (strict mode). - `maxEndpointDelayMs` number — Maximum delay in milliseconds between when the speaker stops and when the endpoint is detected. Lower values mean faster turn-taking but more false endpoints. Range: 500-3000. Default: 500. - `endpointSensitivity` number — How likely Soniox is to emit an endpoint (end the caller turn). Higher values make endpoints more likely for faster turn-taking; negative values make them less likely, which helps when callers pause mid-sentence (e.g. reading numbers group by group). Range: -1.0 to 1.0. Default: 0.3 (the platform low-latency voice profile; Soniox's own default is 0.0). Supported by stt-rt-v5; omitted from the Soniox request on explicit stt-rt-v4. Soniox recommends tuning endpointLatencyAdjustmentLevel first, and advises against negative sensitivity while the level is above 0 (the settings work against each other). - `endpointLatencyAdjustmentLevel` number — How aggressively Soniox reduces endpoint latency. 0 is Soniox's default semantic endpointing; 3 is the most aggressive. Higher levels return endpoints sooner but may split speech into more segments and slightly reduce accuracy. Integer. Range: 0-3. Default: 2 (the platform low-latency voice profile; Soniox's own default is 0). Supported by stt-rt-v5; omitted from the Soniox request on explicit stt-rt-v4. - `customVocabulary` string[] — Custom vocabulary terms to boost recognition accuracy. Useful for brand names, product names, and domain-specific terminology. Maps to Soniox context.terms. - `contextGeneral` SonioxContextGeneralItem[] — General context key-value pairs that guide the AI model during transcription. Helps adapt vocabulary to the correct domain, improving accuracy. Recommended: 10 or fewer pairs. Maps to Soniox context.general. - `key` string, required — The key describing the type of context (e.g., "domain", "topic", "doctor", "organization"). - `value` string, required — The value for the context key (e.g., "Healthcare", "Diabetes management consultation"). - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - XaiTranscriber - `provider` 'xai', required - `model` 'default' — The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection. - `language` 'ar' | 'cs' | 'da' | 'nl' | 'en' | 'fil' | 'fr' | 'de' | 'hi' | 'id' | 'it' | 'ja' | 'ko' | 'mk' | 'ms' | 'fa' | 'pl' | 'pt' | 'ro' | 'ru' | 'es' | 'sv' | 'th' | 'tr' | 'vi' — Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). Defaults to `en` if not set. xAI auto-detects when omitted via the API but Vapi defaults to English for deterministic behavior. - `fallbackPlan` FallbackTranscriberPlan - `transcribers` union[] - union - … - VapiTranscriber - `provider` 'vapi', required - `version` 'latest' | '1' — This is the version of the Vapi transcriber. Vapi manages the underlying model and routing. When omitted, the latest version is used. Managed version params are additive-only and `'latest'` is an auto-update channel — see the param-evolution INVARIANT in `vapiManaged/types.ts`. - `language` 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yue' | 'yo' | 'za' | 'zh' | 'zu' — This is the language for transcription as an ISO 639-1 code (e.g. `en`). Selecting a language locks transcription to it. For multiple languages, use `languages` instead. When neither `language` nor `languages` is set, the transcriber auto-detects the spoken language. - `languages` string[] — These are the languages for transcription as ISO 639-1 codes. Set one or more codes to restrict and bias recognition to those languages. An empty array `[]` (or omitting both this and `language`) enables auto-detection of the spoken language. - `keywords` string[] — These are custom keywords/vocabulary to boost recognition of use-case specific words (company names, product names, jargon). - `turnTaking` 'intelligent' | 'manual' — This is the turn-taking mode. `intelligent` uses the underlying model's native end-of-turn detection; `manual` ignores it and waits a fixed end-of-turn delay. Defaults to `intelligent`. - `model` union — These are the options for the assistant's LLM. - AnthropicModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'claude-3-opus-20240229' | 'claude-3-sonnet-20240229' | 'claude-3-haiku-20240307' | 'claude-3-5-sonnet-20240620' | 'claude-3-5-sonnet-20241022' | 'claude-3-5-haiku-20241022' | 'claude-3-7-sonnet-20250219' | 'claude-opus-4-20250514' | 'claude-opus-4-5-20251101' | 'claude-opus-4-6' | 'claude-sonnet-4-20250514' | 'claude-sonnet-4-5-20250929' | 'claude-sonnet-4-6' | 'claude-sonnet-5' | 'claude-haiku-4-5-20251001', required — The specific Anthropic/Claude model that will be used. - `provider` 'anthropic', required — The provider identifier for Anthropic. - `thinking` AnthropicThinkingConfig - `type` 'enabled', required - `budgetTokens` number, required — The maximum number of tokens to allocate for thinking. Must be between 1024 and 100000 tokens. - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - AnthropicBedrockModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'anthropic-bedrock', required — The provider identifier for Anthropic via AWS Bedrock. - `model` 'claude-3-opus-20240229' | 'claude-3-sonnet-20240229' | 'claude-3-haiku-20240307' | 'claude-3-5-sonnet-20240620' | 'claude-3-5-sonnet-20241022' | 'claude-3-5-haiku-20241022' | 'claude-3-7-sonnet-20250219' | 'claude-opus-4-20250514' | 'claude-opus-4-5-20251101' | 'claude-opus-4-6' | 'claude-sonnet-4-20250514' | 'claude-sonnet-4-5-20250929' | 'claude-sonnet-4-6' | 'claude-haiku-4-5-20251001' | 'global.anthropic.claude-haiku-4-5-20251001-v1:0', required — The specific Anthropic/Claude model that will be used via Bedrock. - `thinking` AnthropicThinkingConfig - `type` 'enabled', required - `budgetTokens` number, required — The maximum number of tokens to allocate for thinking. Must be between 1024 and 100000 tokens. - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - AnyscaleModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'anyscale', required - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - CerebrasModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'llama3.1-8b' | 'llama-3.3-70b', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `provider` 'cerebras', required - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - CustomLLMModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'custom-llm', required — This is the provider that will be used for the model. Any service, including your own server, that is compatible with the OpenAI API can be used. - `metadataSendMode` 'off' | 'variable' | 'destructured' — This determines whether metadata is sent in requests to the custom provider. - `off` will not send any metadata. payload will look like `{ messages }` - `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }` - `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }` Further, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload. Default is `variable`. - `headers` object — Custom headers to send with requests. These headers can override default OpenAI headers except for Authorization (which should be specified using a custom-llm credential). - `url` string, required — These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 - `wordLevelConfidenceEnabled` boolean — This determines whether the transcriber's word level confidence is sent in requests to the custom provider. Default is false. This only works for Deepgram transcribers. - `timeoutSeconds` number — This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds. - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - DeepInfraModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'deepinfra', required - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - DeepSeekModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'deepseek-chat' | 'deepseek-reasoner', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `provider` 'deep-seek', required - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - GoogleModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'gemini-3.5-flash' | 'gemini-3.1-flash-lite' | 'gemini-3-flash-preview' | 'gemini-2.5-pro' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-2.0-flash-thinking-exp' | 'gemini-2.0-pro-exp-02-05' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.0-flash-exp' | 'gemini-2.0-flash-realtime-exp' | 'gemini-1.5-flash' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro', required — This is the Google model that will be used. - `provider` 'google', required - `realtimeConfig` GoogleRealtimeConfig - `topP` number — This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation. Only applicable with the Gemini Flash 2.0 Multimodal Live API. - `topK` number — This is the top-k sampling parameter that limits the number of highest probability tokens considered during text generation. Only applicable with the Gemini Flash 2.0 Multimodal Live API. - `presencePenalty` number — This is the presence penalty parameter that influences the model's likelihood to repeat information by penalizing tokens based on their presence in the text. Only applicable with the Gemini Flash 2.0 Multimodal Live API. - `frequencyPenalty` number — This is the frequency penalty parameter that influences the model's likelihood to repeat tokens by penalizing them based on their frequency in the text. Only applicable with the Gemini Flash 2.0 Multimodal Live API. - `speechConfig` GeminiMultimodalLiveSpeechConfig - `voiceConfig` GeminiMultimodalLiveVoiceConfig, required - … - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - GroqModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'openai/gpt-oss-20b' | 'openai/gpt-oss-120b' | 'deepseek-r1-distill-llama-70b' | 'llama-3.3-70b-versatile' | 'llama-3.1-405b-reasoning' | 'llama-3.1-8b-instant' | 'llama3-8b-8192' | 'llama3-70b-8192' | 'gemma2-9b-it' | 'moonshotai/kimi-k2-instruct-0905' | 'meta-llama/llama-4-scout-17b-16e-instruct' | 'mistral-saba-24b' | 'compound-beta' | 'compound-beta-mini', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `provider` 'groq', required - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - InflectionAIModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'inflection_3_pi', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `provider` 'inflection-ai', required - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - MinimaxLLMModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'minimax', required - `model` 'MiniMax-M2.7', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - OpenAIModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'openai', required — This is the provider that will be used for the model. - `model` 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-5.5' | 'chat-latest' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.2' | 'gpt-5.2-chat-latest' | 'gpt-5.1' | 'gpt-5.1-chat-latest' | 'gpt-5' | 'gpt-5-chat-latest' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'chatgpt-4o-latest' | 'o3' | 'o3-mini' | 'o4-mini' | 'o1-mini' | 'o1-mini-2024-09-12' | 'gpt-4o-realtime-preview-2024-10-01' | 'gpt-4o-realtime-preview-2024-12-17' | 'gpt-4o-mini-realtime-preview-2024-12-17' | 'gpt-realtime-2025-08-28' | 'gpt-realtime-mini-2025-12-15' | 'gpt-realtime-2' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-5.6-luna:westus3' | 'gpt-5.6-terra:westus3' | 'gpt-5.6-sol:westus3' | 'gpt-5.4:eastus2' | 'gpt-5.4:swedencentral' | 'gpt-5.4-mini:eastus2' | 'gpt-5.4-mini:swedencentral' | 'gpt-5.4-nano:eastus2' | 'gpt-5.4-nano:swedencentral' | 'gpt-5.2:eastus2' | 'gpt-5.2:swedencentral' | 'gpt-5.1:eastus2' | 'gpt-5.1:swedencentral' | 'gpt-5:eastus2' | 'gpt-5:swedencentral' | 'gpt-5:canadaeast' | 'gpt-5:eastus' | 'gpt-5:westeurope' | 'gpt-5:germanywestcentral' | 'gpt-5:polandcentral' | 'gpt-5:spaincentral' | 'gpt-5-mini:eastus2' | 'gpt-5-mini:swedencentral' | 'gpt-5-mini:westeurope' | 'gpt-5-mini:germanywestcentral' | 'gpt-5-mini:polandcentral' | 'gpt-5-mini:spaincentral' | 'gpt-5-nano:eastus2' | 'gpt-5-nano:swedencentral' | 'gpt-4.1-2025-04-14:westus' | 'gpt-4.1-2025-04-14:eastus2' | 'gpt-4.1-2025-04-14:eastus' | 'gpt-4.1-2025-04-14:westus3' | 'gpt-4.1-2025-04-14:northcentralus' | 'gpt-4.1-2025-04-14:southcentralus' | 'gpt-4.1-2025-04-14:westeurope' | 'gpt-4.1-2025-04-14:germanywestcentral' | 'gpt-4.1-2025-04-14:polandcentral' | 'gpt-4.1-2025-04-14:spaincentral' | 'gpt-4.1-mini-2025-04-14:westus' | 'gpt-4.1-mini-2025-04-14:eastus2' | 'gpt-4.1-mini-2025-04-14:eastus' | 'gpt-4.1-mini-2025-04-14:westus3' | 'gpt-4.1-mini-2025-04-14:northcentralus' | 'gpt-4.1-mini-2025-04-14:southcentralus' | 'gpt-4.1-mini-2025-04-14:westeurope' | 'gpt-4.1-mini-2025-04-14:germanywestcentral' | 'gpt-4.1-mini-2025-04-14:polandcentral' | 'gpt-4.1-mini-2025-04-14:spaincentral' | 'gpt-4.1-nano-2025-04-14:westus' | 'gpt-4.1-nano-2025-04-14:eastus2' | 'gpt-4.1-nano-2025-04-14:westus3' | 'gpt-4.1-nano-2025-04-14:northcentralus' | 'gpt-4.1-nano-2025-04-14:southcentralus' | 'gpt-4o-2024-11-20:swedencentral' | 'gpt-4o-2024-11-20:westus' | 'gpt-4o-2024-11-20:eastus2' | 'gpt-4o-2024-11-20:eastus' | 'gpt-4o-2024-11-20:westus3' | 'gpt-4o-2024-11-20:southcentralus' | 'gpt-4o-2024-11-20:westeurope' | 'gpt-4o-2024-11-20:germanywestcentral' | 'gpt-4o-2024-11-20:polandcentral' | 'gpt-4o-2024-11-20:spaincentral' | 'gpt-4o-2024-08-06:westus' | 'gpt-4o-2024-08-06:westus3' | 'gpt-4o-2024-08-06:eastus' | 'gpt-4o-2024-08-06:eastus2' | 'gpt-4o-2024-08-06:northcentralus' | 'gpt-4o-2024-08-06:southcentralus' | 'gpt-4o-mini-2024-07-18:westus' | 'gpt-4o-mini-2024-07-18:westus3' | 'gpt-4o-mini-2024-07-18:eastus' | 'gpt-4o-mini-2024-07-18:eastus2' | 'gpt-4o-mini-2024-07-18:northcentralus' | 'gpt-4o-mini-2024-07-18:southcentralus' | 'gpt-4o-2024-05-13:eastus2' | 'gpt-4o-2024-05-13:eastus' | 'gpt-4o-2024-05-13:northcentralus' | 'gpt-4o-2024-05-13:southcentralus' | 'gpt-4o-2024-05-13:westus3' | 'gpt-4o-2024-05-13:westus' | 'gpt-4-turbo-2024-04-09:eastus2' | 'gpt-4-0125-preview:eastus' | 'gpt-4-0125-preview:northcentralus' | 'gpt-4-0125-preview:southcentralus' | 'gpt-4-1106-preview:australiaeast' | 'gpt-4-1106-preview:canadaeast' | 'gpt-4-1106-preview:france' | 'gpt-4-1106-preview:india' | 'gpt-4-1106-preview:norway' | 'gpt-4-1106-preview:swedencentral' | 'gpt-4-1106-preview:uk' | 'gpt-4-1106-preview:westus' | 'gpt-4-1106-preview:westus3' | 'gpt-4-0613:canadaeast' | 'gpt-3.5-turbo-0125:canadaeast' | 'gpt-3.5-turbo-0125:northcentralus' | 'gpt-3.5-turbo-0125:southcentralus' | 'gpt-3.5-turbo-1106:canadaeast' | 'gpt-3.5-turbo-1106:westus' | 'gpt-4.1:australiaeast' | 'gpt-4o:australiaeast' | 'gpt-5.4-mini:australiaeast', required — This is the OpenAI model that will be used. When using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense. This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/. @default undefined - `fallbackModels` string[] — These are the fallback models that will be used if the primary model fails. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest fallbacks that make sense. - `toolStrictCompatibilityMode` 'strip-parameters-with-unsupported-validation' | 'strip-unsupported-validation' — Azure OpenAI doesn't support `maxLength` right now https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/structured-outputs?tabs=python-secure%2Cdotnet-entra-id&pivots=programming-language-csharp#unsupported-type-specific-keywords. Need to strip. - `strip-parameters-with-unsupported-validation` will strip parameters with unsupported validation. - `strip-unsupported-validation` will keep the parameters but strip unsupported validation. @default `strip-unsupported-validation` - `promptCacheRetention` 'in_memory' | '24h' — This controls the prompt cache retention policy for models that support extended caching (GPT-4.1, GPT-5 series). - `in_memory`: Default behavior, cache retained in GPU memory only - `24h`: Extended caching, keeps cached prefixes active for up to 24 hours by offloading to GPU-local storage Only applies to models: gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-5.5, chat-latest, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gpt-5.2, gpt-5.1, gpt-5.1-codex, gpt-5.1-codex-mini, gpt-5.1-chat-latest, gpt-5, gpt-5-codex, gpt-4.1 @default undefined (uses API default which is 'in_memory') - `promptCacheKey` string — This is the prompt cache key for models that support extended caching (GPT-4.1, GPT-5 series). Providing a cache key allows you to share cached prefixes across requests. @default undefined - `reasoningEffort` 'minimal' | 'none' | 'low' | 'medium' | 'high' | 'xhigh' — Reasoning effort for reasoning-capable OpenAI models. For `gpt-realtime-2`: forwarded to V2 stream's session.update as `reasoning.effort`. For non-realtime OpenAI models, model-aware validation limits newly public values while preserving the existing four-value storage contract. - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - OpenRouterModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'openrouter', required - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - PerplexityAIModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'perplexity-ai', required - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - TogetherAIModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `provider` 'together-ai', required - `model` string, required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - XaiModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` 'grok-beta' | 'grok-2' | 'grok-3' | 'grok-4-fast-reasoning' | 'grok-4-fast-non-reasoning' | 'grok-4.20-0309-reasoning' | 'grok-4.20-0309-non-reasoning' | 'grok-4.3', required — This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b - `provider` 'xai', required - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `maxTokens` number — This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - VapiModel - `messages` OpenAIMessage[] — This is the starting state for the conversation. - `content` string, nullable, required - `role` 'assistant' | 'function' | 'user' | 'system' | 'tool', required - `tools` union[] — These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`. Both `tools` and `toolIds` can be used together. - union - CreateApiRequestToolDTO - … - CreateBashToolDTO - … - CreateCodeToolDTO - … - CreateComputerToolDTO - … - CreateDtmfToolDTO - … - CreateEndCallToolDTO - … - CreateFunctionToolDTO - … - CreateGoHighLevelCalendarAvailabilityToolDTO - … - CreateGoHighLevelCalendarEventCreateToolDTO - … - CreateGoHighLevelContactCreateToolDTO - … - CreateGoHighLevelContactGetToolDTO - … - CreateGoogleCalendarCheckAvailabilityToolDTO - … - CreateGoogleCalendarCreateEventToolDTO - … - CreateGoogleSheetsRowAppendToolDTO - … - CreateHandoffToolDTO - … - CreateMcpToolDTO - … - CreateQueryToolDTO - … - CreateSlackSendMessageToolDTO - … - CreateSmsToolDTO - … - CreateTextEditorToolDTO - … - CreateTransferCallToolDTO - … - CreateSipRequestToolDTO - … - CreateVoicemailToolDTO - … - `toolIds` string[] — These are the tools that the assistant can use during the call. To use transient tools, use `tools`. Both `tools` and `toolIds` can be used together. - `toolRefs` ToolRef[] — These are version-pinned references to tools. Each entry pins a specific version of a tool by `(toolId, version)`. When the same `toolId` appears in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the `toolIds` entry is dropped at write time). - `toolId` string, uuid, required — This is the unique identifier of the tool whose version is being pinned. - `version` string, required — Public version label of the tool, e.g. "v3" - `knowledgeBase` CreateCustomKnowledgeBaseDTO - `provider` 'custom-knowledge-base', required — This knowledge base is bring your own knowledge base implementation. - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `model` string — White-label Vapi models are selected by `version`, not a model name, so `model` is optional here (the runtime already accepts a version-only Vapi payload). Overriding the required `ModelBase.model`: the declared type stays `string` to match the base (avoids TS2416) and the `= undefined!` initializer satisfies TS2612 for the field override, while `@IsOptional` + `@ApiPropertyOptional` make validation and the generated OpenAPI schema treat it as optional (so `VapiModel.required` is `['provider']`). - `version` 'latest' | '1' — Vapi-managed model version (update channel). When set, this is a Vapi-managed LLM routed by the registry; when absent, this is the legacy workflow form below (`steps` / `workflow`). - `provider` 'vapi', required - `workflowId` string — This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead. - `workflow` WorkflowUserEditable - `nodes` union[], required - union - … - `model` union — This is the model for the workflow. This can be overridden at node level using `nodes[n].model`. - WorkflowOpenAIModel - … - WorkflowAnthropicModel - … - WorkflowAnthropicBedrockModel - … - WorkflowGoogleModel - … - WorkflowCustomModel - … - `transcriber` union — This is the transcriber for the workflow. This can be overridden at node level using `nodes[n].transcriber`. - AssemblyAITranscriber - … - AzureSpeechTranscriber - … - CustomTranscriber - … - DeepgramTranscriber - … - ElevenLabsTranscriber - … - GladiaTranscriber - … - GoogleTranscriber - … - SpeechmaticsTranscriber - … - TalkscriberTranscriber - … - OpenAITranscriber - … - CartesiaTranscriber - … - SonioxTranscriber - … - XaiTranscriber - … - VapiTranscriber - … - `voice` union — This is the voice for the workflow. This can be overridden at node level using `nodes[n].voice`. - AzureVoice - … - CartesiaVoice - … - CustomVoice - … - DeepgramVoice - … - ElevenLabsVoice - … - HumeVoice - … - LMNTVoice - … - NeuphonicVoice - … - OpenAIVoice - … - PlayHTVoice - … - WellSaidVoice - … - RimeAIVoice - … - SmallestAIVoice - … - TavusVoice - … - VapiVoice - … - SesameVoice - … - InworldVoice - … - MinimaxVoice - … - XaiVoice - … - MicrosoftVoice - … - `observabilityPlan` LangfuseObservabilityPlan - `provider` 'langfuse', required - `promptName` string — The name of a Langfuse prompt to link generations to. This enables tracking which prompt version was used for each generation. https://langfuse.com/docs/prompt-management/features/link-to-traces - `promptVersion` number — The version number of the Langfuse prompt to link generations to. Used together with promptName to identify the exact prompt version. https://langfuse.com/docs/prompt-management/features/link-to-traces - `traceName` string — Custom name for the Langfuse trace. Supports Liquid templates. Available variables: - {{ call.id }} - Call UUID - {{ call.type }} - 'inboundPhoneCall', 'outboundPhoneCall', 'webCall' - {{ assistant.name }} - Assistant name - {{ assistant.id }} - Assistant ID Example: "{{ assistant.name }} - {{ call.type }}" Defaults to call ID if not provided. - `tags` string[], required — This is an array of tags to be added to the Langfuse trace. Tags allow you to categorize and filter traces. https://langfuse.com/docs/tracing-features/tags - `metadata` object — This is a JSON object that will be added to the Langfuse trace. Traces can be enriched with metadata to better understand your users, application, and experiments. https://langfuse.com/docs/tracing-features/metadata By default it includes the call metadata, assistant metadata, and assistant overrides. - `backgroundSound` union — This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. You can also provide a custom sound by providing a URL to an audio file. - 'off' | 'office' - string, uri - `hooks` union[] — This is a set of actions that will be performed on certain events. - union - … - `credentials` union[] — These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. - union - … - `voicemailDetection` union — This is the voicemail detection plan for the workflow. - 'off' - GoogleVoicemailDetectionPlan - … - OpenAIVoicemailDetectionPlan - … - TwilioVoicemailDetectionPlan - … - VapiVoicemailDetectionPlan - … - `maxDurationSeconds` number — This is the maximum duration of the call in seconds. After this duration, the call will automatically end. Default is 1800 (30 minutes), max is 43200 (12 hours), and min is 10 seconds. - `name` string, required - `edges` Edge[], required - `condition` AIEdgeCondition - … - `from` string, required - `to` string, required - `metadata` object — This is for metadata you want to store on the edge. - `globalPrompt` string - `server` Server - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - … - `compliancePlan` CompliancePlan - `hipaaEnabled` boolean — When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false. Only HIPAA-compliant providers will be available for LLM, Voice, and Transcriber respectively. This setting is only honored if the organization is on an Enterprise subscription or has purchased the HIPAA add-on. - `pciEnabled` boolean — When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored. At the end of the call, you will receive an end-of-call-report message to store on your server. Defaults to false. - `securityFilterPlan` SecurityFilterPlan - … - `recordingConsentPlan` union - … - `analysisPlan` AnalysisPlan - `minMessagesThreshold` number — The minimum number of messages required to run the analysis plan. If the number of messages is less than this, analysis will be skipped. @default 2 - `summaryPlan` SummaryPlan - … - `structuredDataPlan` StructuredDataPlan - … - `structuredDataMultiPlan` StructuredDataMultiPlan[] — This is an array of structured data plan catalogs. Each entry includes a `key` and a `plan` for generating the structured data from the call. This outputs to `call.analysis.structuredDataMulti`. - … - `successEvaluationPlan` SuccessEvaluationPlan - … - `outcomeIds` string[] — This is an array of outcome UUIDs to be calculated during analysis. The outcomes will be calculated and stored in `call.analysis.outcomes`. - `artifactPlan` ArtifactPlan - `recordingEnabled` boolean — This determines whether assistant's calls are recorded. Defaults to true. Usage: - If you don't want to record the calls, set this to false. - If you want to record the calls when `assistant.hipaaEnabled` (deprecated) or `assistant.compliancePlan.hipaaEnabled` explicity set this to true and make sure to provide S3 or GCP credentials on the Provider Credentials page in the Dashboard. You can find the recording at `call.artifact.recordingUrl` and `call.artifact.stereoRecordingUrl` after the call is ended. @default true - `recordingFormat` 'wav;l16' | 'mp3' — This determines the format of the recording. Defaults to `wav;l16`. @default 'wav;l16' - `recordingUseCustomStorageEnabled` boolean — This determines whether to use custom storage (S3 or GCP) for call recordings when storage credentials are configured. When set to false, recordings will be stored on Vapi's storage instead of your custom storage, even if you have custom storage credentials configured. Usage: - Set to false if you have custom storage configured but want to store recordings on Vapi's storage for this assistant. - Set to true (or leave unset) to use your custom storage for recordings when available. If your organization has ZDR (zero data retention) or PCI enabled, recordings are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. @default true - `videoRecordingEnabled` boolean — This determines whether the video is recorded during the call. Defaults to false. Only relevant for `webCall` type. You can find the video recording at `call.artifact.videoRecordingUrl` after the call is ended. @default false - `fullMessageHistoryEnabled` boolean — This determines whether the artifact contains the full message history, even after handoff context engineering. Defaults to false. - `pcapEnabled` boolean — This determines whether the SIP packet capture is enabled. Defaults to true. Only relevant for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`. You can find the packet capture at `call.artifact.pcapUrl` after the call is ended. @default true - `pcapS3PathPrefix` string — This is the path where the SIP packet capture will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard. If credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it. Usage: - If you want to upload the packet capture to a specific path, set this to the path. Example: `/my-assistant-captures`. - If you want to upload the packet capture to the root of the bucket, set this to `/`. @default '/' - `pcapUseCustomStorageEnabled` boolean — This determines whether to use custom storage (S3 or GCP) for SIP packet captures when storage credentials are configured. When set to false, packet captures will be stored on Vapi's storage instead of your custom storage, even if you have custom storage credentials configured. Usage: - Set to false if you have custom storage configured but want to store packet captures on Vapi's storage for this assistant. - Set to true (or leave unset) to use your custom storage for packet captures when available. If your organization has ZDR (zero data retention) or PCI enabled, packet captures are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. @default true - `loggingEnabled` boolean — This determines whether the call logs are enabled. Defaults to true. @default true - `loggingUseCustomStorageEnabled` boolean — This determines whether to use custom storage (S3 or GCP) for call logs when storage credentials are configured. When set to false, logs will be stored on Vapi's storage instead of your custom storage, even if you have custom storage credentials configured. Usage: - Set to false if you have custom storage configured but want to store logs on Vapi's storage for this assistant. - Set to true (or leave unset) to use your custom storage for logs when available. If your organization has ZDR (zero data retention) or PCI enabled, logs are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. @default true - `transcriptPlan` TranscriptPlan - … - `recordingPath` string — This is the path where the recording will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard. If credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it. Usage: - If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`. - If you want to upload the recording to the root of the bucket, set this to `/`. @default '/' - `structuredOutputIds` string[] — This is an array of structured output IDs to be calculated during the call. The outputs will be extracted and stored in `call.artifact.structuredOutputs` after the call is ended. - `structuredOutputs` CreateStructuredOutputDTO[] — This is an array of transient structured outputs to be calculated during the call. The outputs will be extracted and stored in `call.artifact.structuredOutputs` after the call is ended. Use this to provide inline structured output configurations instead of referencing existing ones via structuredOutputIds. - … - `scorecardIds` string[] — This is an array of scorecard IDs that will be evaluated based on the structured outputs extracted during the call. The scorecards will be evaluated and the results will be stored in `call.artifact.scorecards` after the call has ended. - `scorecards` CreateScorecardDTO[] — This is the array of scorecards that will be evaluated based on the structured outputs extracted during the call. The scorecards will be evaluated and the results will be stored in `call.artifact.scorecards` after the call has ended. - … - `loggingPath` string — This is the path where the call logs will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard. If credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it. Usage: - If you want to upload the call logs to a specific path, set this to the path. Example: `/my-assistant-logs`. - If you want to upload the call logs to the root of the bucket, set this to `/`. @default '/' - `startSpeakingPlan` StartSpeakingPlan - `waitSeconds` number — This is how long assistant waits before speaking. Defaults to 0.4. This is the minimum it will wait but if there is latency is the pipeline, this minimum will be exceeded. This is intended as a stopgap in case the pipeline is moving too fast. Example: - If model generates tokens and voice generates bytes within 100ms, the pipeline still waits 300ms before outputting speech. Usage: - If the customer is taking long pauses, set this to a higher value. - If the assistant is accidentally jumping in too much, set this to a higher value. @default 0.4 - `smartEndpointingEnabled` union - … - `smartEndpointingPlan` union — This is the plan for smart endpointing. Pick between Vapi smart endpointing, LiveKit, or custom endpointing model (or nothing). We strongly recommend using livekit endpointing when working in English. LiveKit endpointing is not supported in other languages, yet. If this is set, it will override and take precedence over `transcriptionEndpointingPlan`. This plan will still be overridden by any matching `customEndpointingRules`. If this is not set, the system will automatically use the transcriber's built-in endpointing capabilities if available. - … - `customEndpointingRules` union[] — These are the custom endpointing rules to set an endpointing timeout based on a regex on the customer's speech or the assistant's last message. Usage: - If you have yes/no questions like "are you interested in a loan?", you can set a shorter timeout. - If you have questions where the customer may pause to look up information like "what's my account number?", you can set a longer timeout. - If you want to wait longer while customer is enumerating a list of numbers, you can set a longer timeout. These rules have the highest precedence and will override both `smartEndpointingPlan` and `transcriptionEndpointingPlan` when a rule is matched. The rules are evaluated in order and the first one that matches will be used. Order of precedence for endpointing: 1. customEndpointingRules (if any match) 2. smartEndpointingPlan (if set) 3. transcriptionEndpointingPlan @default [] - … - `transcriptionEndpointingPlan` TranscriptionEndpointingPlan - … - `stopSpeakingPlan` StopSpeakingPlan - `numWords` number — This is the number of words that the customer has to say before the assistant will stop talking. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. When set to 0, `voiceSeconds` is used in addition to the transcriptions to determine the customer has started speaking. Defaults to 0. @default 0 - `voiceSeconds` number — This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking. Considerations: - A lower value might be more responsive but could potentially pick up non-speech sounds. - A higher value reduces false positives but might slightly delay the detection of speech onset. This is only used if `numWords` is set to 0. Defaults to 0.2 @default 0.2 - `backoffSeconds` number — This is the seconds to wait before the assistant will start talking again after being interrupted. Defaults to 1. @default 1 - `acknowledgementPhrases` string[] — These are the phrases that will never interrupt the assistant, even if numWords threshold is met. These are typically acknowledgement or backchanneling phrases. - `interruptionPhrases` string[] — These are the phrases that will always interrupt the assistant immediately, regardless of numWords. These are typically phrases indicating disagreement or desire to stop. - `monitorPlan` MonitorPlan - `listenEnabled` boolean — This determines whether the assistant's calls allow live listening. Defaults to true. Fetch `call.monitor.listenUrl` to get the live listening URL. @default true - `listenAuthenticationEnabled` boolean — This enables authentication on the `call.monitor.listenUrl`. If `listenAuthenticationEnabled` is `true`, the `call.monitor.listenUrl` will require an `Authorization: Bearer ` header. @default false - `controlEnabled` boolean — This determines whether the assistant's calls allow live control. Defaults to true. Fetch `call.monitor.controlUrl` to get the live control URL. To use, send any control message via a POST request to `call.monitor.controlUrl`. Here are the types of controls supported: https://docs.vapi.ai/api-reference/messages/client-inbound-message @default true - `controlAuthenticationEnabled` boolean — This enables authentication on the `call.monitor.controlUrl`. If `controlAuthenticationEnabled` is `true`, the `call.monitor.controlUrl` will require an `Authorization: Bearer ` header. @default false - `monitorIds` string[] — This the set of monitor ids that are attached to the assistant. The source of truth for the monitor ids is the assistant_monitor join table. This field can be used for transient assistants and to update assistants with new monitor ids. @default [] - `backgroundSpeechDenoisingPlan` BackgroundSpeechDenoisingPlan - `smartDenoisingPlan` SmartDenoisingPlan - … - `fourierDenoisingPlan` FourierDenoisingPlan - … - `credentialIds` string[] — These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this. - `keypadInputPlan` KeypadInputPlan - `enabled` boolean — This keeps track of whether the user has enabled keypad input. By default, it is off. @default false - `timeoutSeconds` number — This is the time in seconds to wait before processing the input. If the input is not received within this time, the input will be ignored. If set to "off", the input will be processed when the user enters a delimiter or immediately if no delimiter is used. @default 2 - `delimiters` '#' | '*' | '' — This is the delimiter(s) that will be used to process the input. Can be '#', '*', or an empty array. - `voicemailMessage` string — This is the message that the assistant will say if the call is forwarded to voicemail. If unspecified, it will hang up. - `temperature` number — This is the temperature that will be used for calls. Default is 0.5. - `emotionRecognitionEnabled` boolean — This determines whether we detect user's emotion while they speak and send it as an additional info to model. Default `false` because the model is usually are good at understanding the user's emotion from text. @default false - `numFastTurns` number — This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0. @default 0 - `voice` union — These are the options for the assistant's voice. - AzureVoice - `cachingEnabled` boolean — This is the flag to toggle voice caching for the assistant. - `provider` 'azure', required — This is the voice provider that will be used. - `voiceId` union, required — This is the provider-specific ID that will be used. - 'andrew' | 'brian' | 'emma' - string - `chunkPlan` ChunkPlan - `enabled` boolean — This determines whether the model output is chunked before being sent to the voice provider. Default `true`. Usage: - To rely on the voice provider's audio generation logic, set this to `false`. - If seeing issues with quality, set this to `true`. If disabled, Vapi-provided audio control tokens like will not work. @default true - `minCharacters` number — This is the minimum number of characters in a chunk. Usage: - To increase quality, set this to a higher value. - To decrease latency, set this to a lower value. @default 30 - `punctuationBoundaries` string[] — These are the punctuations that are considered valid boundaries for a chunk to be created. Usage: - To increase quality, constrain to fewer boundaries. - To decrease latency, enable all. Default is automatically set to balance the trade-off between quality and latency based on the provider. - `formatPlan` FormatPlan - `enabled` boolean — This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. Usage: - To rely on the voice provider's formatting logic, set this to `false`. If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format. @default true - `numberToDigitsCutoff` number — This is the cutoff after which a number is converted to individual digits instead of being spoken as words. Example: - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted to "twelve hundred". Usage: - If your use case doesn't involve IDs like zip codes, set this to a high value. - If your use case involves IDs that are shorter than 5 digits, set this to a lower value. @default 2025 - `replacements` union[] — These are the custom replacements you can make to the chunk before it is sent to the voice provider. Usage: - To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }` - To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }` @default [] - … - `formattersEnabled` string[] — List of formatters to apply. If not provided, all default formatters will be applied. If provided, only the specified formatters will be applied. Note: Some essential formatters like angle bracket removal will always be applied. @default undefined - `speed` number — This is the speed multiplier that will be used. - `fallbackPlan` FallbackPlan - `voices` union[], required — This is the list of voices to fallback to in the event that the primary voice provider fails. - union - … - CartesiaVoice - `cachingEnabled` boolean — This is the flag to toggle voice caching for the assistant. - `provider` 'cartesia', required — This is the voice provider that will be used. - `voiceId` string, required — The ID of the particular voice you want to use. - `model` 'sonic-3.5' | 'sonic-3.5-2026-05-04' | 'sonic-3' | 'sonic-3-2026-01-12' | 'sonic-3-2025-10-27' | 'sonic-2' | 'sonic-2-2025-06-11' | 'sonic-english' | 'sonic-multilingual' | 'sonic-preview' | 'sonic' — This is the model that will be used. This is optional and will default to the correct model for the voiceId. - `language` 'ar' | 'bg' | 'bn' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'gu' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'ml' | 'mr' | 'ms' | 'nl' | 'no' | 'pa' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sv' | 'ta' | 'te' | 'th' | 'tl' | 'tr' | 'uk' | 'vi' | 'zh' — This is the language that will be used. This is optional and will default to the correct language for the voiceId. - `experimentalControls` CartesiaExperimentalControls - `speed` union - 'slowest' | 'slow' | 'normal' | 'fast' | 'fastest' - number - `emotion` 'anger:lowest' | 'anger:low' | 'anger:high' | 'anger:highest' | 'positivity:lowest' | 'positivity:low' | 'positivity:high' | 'positivity:highest' | 'surprise:lowest' | 'surprise:low' | 'surprise:high' | 'surprise:highest' | 'sadness:lowest' | 'sadness:low' | 'sadness:high' | 'sadness:highest' | 'curiosity:lowest' | 'curiosity:low' | 'curiosity:high' | 'curiosity:highest' - `generationConfig` CartesiaGenerationConfig - `speed` number — Fine-grained speed control for sonic-3. Only available for sonic-3 model. - `volume` number — Fine-grained volume control for sonic-3. Only available for sonic-3 model. - `experimental` CartesiaGenerationConfigExperimental - `accentLocalization` integer — Toggle accent localization for sonic-3: 0 (disabled, default) or 1 (enabled). When enabled, the voice adapts to match the transcript language accent while preserving vocal characteristics. - `pronunciationDictId` string — Pronunciation dictionary ID for sonic-3. Allows custom pronunciations for specific words. Only available for sonic-3 model. - `chunkPlan` ChunkPlan - `enabled` boolean — This determines whether the model output is chunked before being sent to the voice provider. Default `true`. Usage: - To rely on the voice provider's audio generation logic, set this to `false`. - If seeing issues with quality, set this to `true`. If disabled, Vapi-provided audio control tokens like will not work. @default true - `minCharacters` number — This is the minimum number of characters in a chunk. Usage: - To increase quality, set this to a higher value. - To decrease latency, set this to a lower value. @default 30 - `punctuationBoundaries` string[] — These are the punctuations that are considered valid boundaries for a chunk to be created. Usage: - To increase quality, constrain to fewer boundaries. - To decrease latency, enable all. Default is automatically set to balance the trade-off between quality and latency based on the provider. - `formatPlan` FormatPlan - `enabled` boolean — This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. Usage: - To rely on the voice provider's formatting logic, set this to `false`. If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format. @default true - `numberToDigitsCutoff` number — This is the cutoff after which a number is converted to individual digits instead of being spoken as words. Example: - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted to "twelve hundred". Usage: - If your use case doesn't involve IDs like zip codes, set this to a high value. - If your use case involves IDs that are shorter than 5 digits, set this to a lower value. @default 2025 - `replacements` union[] — These are the custom replacements you can make to the chunk before it is sent to the voice provider. Usage: - To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }` - To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }` @default [] - … - `formattersEnabled` string[] — List of formatters to apply. If not provided, all default formatters will be applied. If provided, only the specified formatters will be applied. Note: Some essential formatters like angle bracket removal will always be applied. @default undefined - `fallbackPlan` FallbackPlan - `voices` union[], required — This is the list of voices to fallback to in the event that the primary voice provider fails. - union - … - CustomVoice - `cachingEnabled` boolean — This is the flag to toggle voice caching for the assistant. - `provider` 'custom-voice', required — This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported. - `voiceId` string — This is the provider-specific ID that will be used. This is passed in the voice request payload to identify the voice to use. - `chunkPlan` ChunkPlan - `enabled` boolean — This determines whether the model output is chunked before being sent to the voice provider. Default `true`. Usage: - To rely on the voice provider's audio generation logic, set this to `false`. - If seeing issues with quality, set this to `true`. If disabled, Vapi-provided audio control tokens like will not work. @default true - `minCharacters` number — This is the minimum number of characters in a chunk. Usage: - To increase quality, set this to a higher value. - To decrease latency, set this to a lower value. @default 30 - `punctuationBoundaries` string[] — These are the punctuations that are considered valid boundaries for a chunk to be created. Usage: - To increase quality, constrain to fewer boundaries. - To decrease latency, enable all. Default is automatically set to balance the trade-off between quality and latency based on the provider. - `formatPlan` FormatPlan - `enabled` boolean — This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. Usage: - To rely on the voice provider's formatting logic, set this to `false`. If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format. @default true - `numberToDigitsCutoff` number — This is the cutoff after which a number is converted to individual digits instead of being spoken as words. Example: - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted to "twelve hundred". Usage: - If your use case doesn't involve IDs like zip codes, set this to a high value. - If your use case involves IDs that are shorter than 5 digits, set this to a lower value. @default 2025 - `replacements` union[] — These are the custom replacements you can make to the chunk before it is sent to the voice provider. Usage: - To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }` - To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }` @default [] - … - `formattersEnabled` string[] — List of formatters to apply. If not provided, all default formatters will be applied. If provided, only the specified formatters will be applied. Note: Some essential formatters like angle bracket removal will always be applied. @default undefined - `server` Server, required - `timeoutSeconds` number — This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20 - `credentialId` string — The credential ID for server authentication - `staticIpAddressesEnabled` boolean — If enabled, requests will originate from a static set of IPs owned and managed by Vapi. @default false - `encryptedPaths` string[] — This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined. - `url` string — This is where the request will be sent. - `headers` object — These are the headers to include in the request. Each key-value pair represents a header name and its value. Note: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios. - `backoffPlan` BackoffPlan - `type` object, required — This is the type of backoff plan to use. Defaults to fixed. @default fixed - `maxRetries` number, required — This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries). @default 0 - `baseDelaySeconds` number, required — This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay. - `excludedStatusCodes` object[] — This is the excluded status codes. If the response status code is in this list, the request will not be retried. By default, the request will be retried for any non-2xx status code. - … - `fallbackPlan` FallbackPlan - `voices` union[], required — This is the list of voices to fallback to in the event that the primary voice provider fails. - union - … - DeepgramVoice - `cachingEnabled` boolean — This is the flag to toggle voice caching for the assistant. - `provider` 'deepgram', required — This is the voice provider that will be used. - `voiceId` 'asteria' | 'luna' | 'stella' | 'athena' | 'hera' | 'orion' | 'arcas' | 'perseus' | 'angus' | 'orpheus' | 'helios' | 'zeus' | 'thalia' | 'andromeda' | 'helena' | 'apollo' | 'arcas' | 'aries' | 'amalthea' | 'asteria' | 'athena' | 'atlas' | 'aurora' | 'callista' | 'cora' | 'cordelia' | 'delia' | 'draco' | 'electra' | 'harmonia' | 'hera' | 'hermes' | 'hyperion' | 'iris' | 'janus' | 'juno' | 'jupiter' | 'luna' | 'mars' | 'minerva' | 'neptune' | 'odysseus' | 'ophelia' | 'orion' | 'orpheus' | 'pandora' | 'phoebe' | 'pluto' | 'saturn' | 'selene' | 'theia' | 'vesta' | 'zeus' | 'celeste' | 'estrella' | 'nestor' | 'sirio' | 'carina' | 'alvaro' | 'diana' | 'aquila' | 'selena' | 'javier' | 'viktoria' | 'kara' | 'fabian' | 'julius' | 'lara' | 'elara' | 'aurelia', required — This is the provider-specific ID that will be used. - `model` 'aura' | 'aura-2' — This is the model that will be used. Defaults to 'aura-2' when not specified. - `mipOptOut` boolean — If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out This will only be used if you are using your own Deepgram API key. @default false - `chunkPlan` ChunkPlan - `enabled` boolean — This determines whether the model output is chunked before being sent to the voice provider. Default `true`. Usage: - To rely on the voice provider's audio generation logic, set this to `false`. - If seeing issues with quality, set this to `true`. If disabled, Vapi-provided audio control tokens like will not work. @default true - `minCharacters` number — This is the minimum number of characters in a chunk. Usage: - To increase quality, set this to a higher value. - To decrease latency, set this to a lower value. @default 30 - `punctuationBoundaries` string[] — These are the punctuations that are considered valid boundaries for a chunk to be created. Usage: - To increase quality, constrain to fewer boundaries. - To decrease latency, enable all. Default is automatically set to balance the trade-off between quality and latency based on the provider. - `formatPlan` FormatPlan - `enabled` boolean — This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. Usage: - To rely on the voice provider's formatting logic, set this to `false`. If `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format. @default true - `numberToDigitsCutoff` number — This is the cutoff after which a number is converted to individual digits instead of being spoken as words. Example: - If cutoff 2025, "12345" is converted to "1 2 3 4 5" while "1200" is converted to "twelve hundred". Usage: - If your use case doesn't involve IDs like zip codes, set this to a high value. - If your use case involves IDs that are shorter than 5 digits, set this to a lower value. @default 2025 - `replacements` union[] — These are the custom replacements you can make to the chunk before it is sent to the voice provider. Usage: - To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }` - To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\b[a-zA-Z]{5}\\b', value: 'hi' }` @default [] - … - … truncated; see the full OpenAPI document linked below --- [API](https://skmtc.dev/vapiai/apis/vapi-api.md) · [All operations](https://skmtc.dev/vapiai/apis/vapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vapiai/vapi-api/revisions/872ff45af53b/schema)