Skip to main content
Vapi logo
  • Category: audio & speech
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 38
  • Triggers: 0
  • Slug: VAPI
  • Version: 20261101_00

Tools

Slug: VAPI_ASSISTANT_CONTROLLER_UPDATETool to update an existing Vapi assistant configuration. Use when you need to modify assistant properties such as name, voice settings, transcriber configuration, model settings, messages, or other behavior parameters. Only include fields you want to update.

Input Parameters

string
required
The unique identifier of the assistant to update
string
The name of the assistant
object
Configuration for the LLM model used by the assistant. Includes provider, model name, temperature, and other model-specific settings
object
Configuration for the text-to-speech voice. Supports providers like ElevenLabs, PlayHT, Rime, Azure, Cartesia, etc.
object
Custom metadata object to attach to the assistant. Can contain any key-value pairs for your use
string
Server URL where assistant events and messages will be sent
object
Configuration for messages to be sent to client and server during the call
object
Configuration for real-time monitoring of assistant’s calls.
object
Configuration for the speech-to-text transcriber. Supports multiple providers like AssemblyAI, Deepgram, Google, Azure, etc. Each provider has specific configuration options
object
Configuration for post-call analysis including summary and structured data extraction.
object
Configuration for artifacts (recordings, transcripts) created during or after the call.
string
The first message that the assistant will say. Can be text or a URL to an audio file (mp3, wav, etc.). If unspecified, assistant will wait for user to speak
boolean
Whether HIPAA compliance is enabled for the assistant
array
List of credential IDs the assistant should use for various integrations
array
List of message types to send to client SDKs
object
Configuration for handling maximum call duration
array
List of message types to send to server URL
string
Background sound in the call. Options: ‘off’, ‘office’. Default is ‘office’ for phone calls and ‘off’ for web calls
string
Message the assistant will say before ending the call
array
Phrases that will trigger the end of the call when spoken by the user
object
Plan for when assistant should stop talking on customer interruption.
string
Secret used to authenticate requests to the server URL
object
Plan for when the assistant should start talking.
string
Message the assistant will say if the call goes to voicemail
string
Mode for the first message. Options: ‘assistant-speaks-first’, ‘assistant-waits-for-user’. Default is ‘assistant-speaks-first’
boolean
Whether backchannel (verbal acknowledgments like ‘uh-huh’, ‘mm-hmm’) is enabled
integer
Maximum number of seconds the call will last, after which it will be ended
number
Delay in seconds before the assistant responds
integer
Number of seconds of silence before the call is ended
array
Configuration for transport protocols (SIP, WebRTC, etc.)
number
Delay in seconds before making LLM requests
boolean
Whether background noise filtering is enabled
boolean
Whether to include model output in messages sent to client/server
integer
Number of words user needs to speak to interrupt the assistant

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CALL_CONTROLLER_FIND_ALLTool to list calls from Vapi. Use when you need to retrieve multiple calls with optional filtering by id, assistantId, phoneNumberId, or date ranges. Returns an array of call objects with details including status, costs, messages, and artifacts.

Input Parameters

string
Unique call identifier. Use to filter for a specific call.
integer
Maximum number of items to return. Defaults to 100 if not specified. Must be between 0 and 1000.
string
Returns calls with the specified assistantId. Use to filter calls by assistant.
string
Returns items where createdAt meets or exceeds the specified value. Use ISO 8601 date-time format (e.g., ‘2024-01-01T00:00:00Z’).
string
Returns items where createdAt exceeds the specified value. Use ISO 8601 date-time format (e.g., ‘2024-01-01T00:00:00Z’).
string
Returns items where createdAt is at or below the specified value. Use ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Returns items where createdAt is below the specified value. Use ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Returns items where updatedAt meets or exceeds the specified value. Use ISO 8601 date-time format (e.g., ‘2024-01-01T00:00:00Z’).
string
Returns items where updatedAt exceeds the specified value. Use ISO 8601 date-time format (e.g., ‘2024-01-01T00:00:00Z’).
string
Returns items where updatedAt is at or below the specified value. Use ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Returns items where updatedAt is below the specified value. Use ISO 8601 date-time format (e.g., ‘2024-12-31T23:59:59Z’).
string
Phone number for the call; for outbound/inbound phone calls only. Use to filter calls by phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CHAT_CONTROLLER_DELETE_CHATTool to delete a chat by its ID from Vapi. Use when you need to permanently remove a chat conversation.

Input Parameters

string
required
The chat identifier to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CHAT_CONTROLLER_GET_CHATFetch chat details by ID, including available messages, costs, and assistant configuration. The response includes selected chat fields rather than the full chat resource.

Input Parameters

string
required
The unique identifier of the chat to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_ANALYTICS_QUERYTool to create and execute analytics queries on VAPI data. Use when you need to analyze call or subscription metrics with aggregations like count, sum, average, min, or max. Supports grouping by various dimensions and time-based analysis with custom time ranges.

Input Parameters

array
required
List of analytics queries to execute. Each query must have a unique name, specify a table, and define operations to perform

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_ASSISTANTTool to create a new Vapi assistant with specified transcriber, voice, and AI model configurations. Use when setting up a conversational AI assistant for voice interactions. The assistant requires transcription (speech-to-text), voice (text-to-speech), and AI model (conversation logic) configurations at minimum.

Input Parameters

string
Assistant identifier/name for easy reference and organization
object
required
AI model for conversation logic (e.g., OpenAI GPT-4, Claude). Define the provider, model name, and initial messages including system prompts to control assistant behavior.
object
required
Text-to-speech settings with provider and voiceId. Select a provider like 11labs, Azure, or OpenAI and specify the voice identifier for the assistant’s speech output.
object
required
Speech-to-text configuration. Choose from providers: AssemblyAI, Azure Speech, Deepgram, ElevenLabs, Gladia, Google, OpenAI, Cartesia, Speechmatics, Talkscriber, or Custom. Configure the model and language for optimal transcription.
string
Initial greeting message the assistant will say when the conversation starts
string
Instructions for AI behavior and personality. Alternative to including system message in model.messages field.
array
List of message types to relay to the client application
array
List of message types to send to the server webhook
integer
Maximum call duration in seconds before automatic termination
object
Voicemail detection configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_EVALTool to create an eval for testing conversation flows. Use when you need to validate that an AI assistant responds correctly to specific conversation scenarios.

Input Parameters

string
Name of the eval to help identify what the eval is checking for
string
required
Type of the eval. Currently fixed to ‘chat.mockConversation’
array
required
Mock conversation messages for evaluating the conversation flow. Mock Messages simulate the conversation flow, and Evaluation Messages are checkpoints where the model’s response is evaluated for content and tool calls
string
Description of the eval and its purpose in detail. Not used to evaluate the conversation flow

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_OPEN_AI_CHATCreate an OpenAI-compatible chat with a Vapi assistant or squad and receive a JSON response. Set streaming to false for a non-streaming response.

Input Parameters

string
The name of the chat. This is just for your own reference.
string
required
The input text for the chat. Can be a string or an array of chat messages. This field is required for chat creation.
object
The squad configuration object that will be used for the chat. Use this to define a transient squad. Mutually exclusive with ‘squadId’ field.
boolean
Whether to stream the response or not. Defaults to true.
string
The squad ID that will be used for the chat. Use this to reference an existing squad. Mutually exclusive with ‘squad’ field.
object
The assistant configuration object that will be used for the chat. Use this to define a transient assistant. Mutually exclusive with ‘assistantId’ field.
string
The ID of the session that will be used for the chat. Mutually exclusive with ‘previousChatId’ and transport fields (phoneNumberId/customer).
object
Used to send the chat through a transport like SMS. If transport.phoneNumberId and transport.customer are provided, creates a new session. Cannot specify both sessionId and transport fields (phoneNumberId/customer) together.
string
The assistant ID that will be used for the chat. Use this to reference an existing assistant. Mutually exclusive with ‘assistant’ field.
string
The ID of the chat that will be used as context for the new chat. The messages from the previous chat will be used as context. Mutually exclusive with ‘sessionId’.
object
Variable values that will be used to replace template variables in the assistant messages. Only variable substitution is supported in chat contexts - other assistant properties cannot be overridden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_POLICYTool to create a monitoring policy in VAPI. Use when you need to set up automated monitoring rules based on thresholds and time windows. Policies can trigger alerts based on event counts or percentages over a specified lookback window.

Input Parameters

string
required
Policy identifier name. This should be a descriptive name for the policy.
object
Interval-based scheduling configuration for policy execution.
object
Cron-like scheduling configuration for policy execution.
string ("error" | "warning" | "info")
required
Severity level of the policy. Use ‘error’ for critical issues, ‘warning’ for concerning patterns, or ‘info’ for informational alerts.
object
required
Threshold configuration that defines when the policy should trigger.
array
List of monitor identifiers to associate with this policy.
integer
required
Time window in minutes for querying events. This defines how far back to look when evaluating the policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_PROVIDER_RESOURCETool to create an 11Labs pronunciation dictionary resource. Use when you need to define custom pronunciations for specific terms or acronyms in voice synthesis.

Input Parameters

string
required
Name of the pronunciation dictionary to create.
array
required
Array of pronunciation rules. Each rule must specify a ‘stringToReplace’ and ‘type’ (either ‘phoneme’ or ‘alias’). For phoneme rules, include ‘phoneme’ and ‘alphabet’ fields. For alias rules, include an ‘alias’ field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_CREATE_SCORECARDTool to create a scorecard for observability and evaluation. Use when setting up metrics to evaluate assistant performance based on structured outputs. Scorecards contain metrics with conditions that calculate normalized scores on a 100-point scale.

Input Parameters

string
Name of the scorecard for user reference. This is not used for any evaluation, only for identification purposes.
array
required
Array of ScorecardMetric objects containing structuredOutputId and conditions for scoring. Each metric will have a set of conditions and points used to generate the score.
string
Description of the scorecard for user reference. This is not used for any evaluation.
array
Assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants’ calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_DELETE_CALLDelete a Vapi call by its unique identifier. The response includes the call ID and may include returned call details.

Input Parameters

string
required
The unique identifier of the call to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_DELETE_EVALTool to delete an eval by ID. Use when you need to permanently remove an eval from the system.

Input Parameters

string
required
The unique identifier of the eval to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_DELETE_PHONE_NUMBERDelete a phone number from your Vapi organization by ID. The response includes the ID and may include returned phone number details.

Input Parameters

string
required
The unique identifier for the phone number to be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_EVAL_CONTROLLER_GETTool to retrieve an eval by its ID. Use when you need to fetch details about a specific eval including its mock conversation messages and metadata.

Input Parameters

string
required
The unique identifier of the eval to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_EVAL_CONTROLLER_REMOVE_RUNTool to delete an eval run by its ID from Vapi. Use when you need to permanently remove an evaluation run.

Input Parameters

string
required
The unique identifier of the eval run to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_EVAL_CONTROLLER_UPDATETool to update an existing eval in Vapi. Use when you need to modify eval properties like name, description, type, or mock conversation messages.

Input Parameters

string
required
The ID of the eval to update
string
This is the name of the eval. It helps identify what the eval is checking for.
string
This is the type of the eval. Currently it is fixed to ‘chat.mockConversation’.
array
This is the mock conversation that will be used to evaluate the flow of the conversation. Mock Messages are used to simulate the flow of the conversation. Evaluation Messages are used as checkpoints in the flow where the model’s response to previous conversation needs to be evaluated to check the content and tool calls.
string
This is the description of the eval. This helps describe the eval and its purpose in detail. It will not be used to evaluate the flow of the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_GET_ASSISTANTTool to retrieve a specific assistant by ID from Vapi. Use when you need to fetch details about an existing assistant.

Input Parameters

string
required
The unique identifier of the assistant to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_GET_CALLFetch selected call details by ID, including available status, cost, messages, and transcript information.

Input Parameters

string
required
Unique identifier of the call to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_GET_FILETool to retrieve a file by its ID from Vapi. Use when you need to get details about a specific file including its status, metadata, storage location, and timestamps.

Input Parameters

string
required
Identifier for the file to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_GET_MONITORINGTool to retrieve monitoring policies from Vapi. Use when you need to list, filter, or search for monitoring policies configured in the organization. Supports filtering by policy ID, severity level, monitor ID, and date ranges for creation/update timestamps.

Input Parameters

string
Returns policies with the specified id
integer
Page number for pagination (defaults to 1)
integer
Maximum number of items returned per page (defaults to 100)
string ("error" | "warning" | "info")
Filters by severity level. Must be one of: error, warning, or info
string
Returns policies associated with the specified monitor ID
string ("ASC" | "DESC")
Sort order for pagination. Must be either ASC or DESC (defaults to DESC)
string
Filter to return items where createdAt is greater than or equal to this ISO 8601 date-time value
string
Filter to return items where createdAt is greater than this ISO 8601 date-time value
string
Filter to return items where createdAt is less than or equal to this ISO 8601 date-time value
string
Filter to return items where createdAt is less than this ISO 8601 date-time value
string
Filter to return items where updatedAt is greater than or equal to this ISO 8601 date-time value
string
Filter to return items where updatedAt is greater than this ISO 8601 date-time value
string
Filter to return items where updatedAt is less than or equal to this ISO 8601 date-time value
string
Filter to return items where updatedAt is less than this ISO 8601 date-time value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_GET_STRUCTURED_OUTPUTSTool to list structured outputs with optional filtering. Use when you need to retrieve structured output configurations with pagination support. Supports filtering by ID, name, timestamps, and includes pagination controls.

Input Parameters

string
Filters results where the identifier matches the specified value
string
Filters results where the name matches the specified value
integer
Page number for results (defaults to 1)
integer
Maximum items returned per request (defaults to 100)
string
Sort direction for pagination. Must be ‘ASC’ or ‘DESC’ (defaults to DESC)
string
Returns items created on or after the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items created after the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items created on or before the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items created before the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items updated on or after the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items updated after the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items updated on or before the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)
string
Returns items updated before the specified timestamp. Must be in ISO 8601 date-time format (e.g., ‘2024-01-15T10:30:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_INSIGHT_CONTROLLER_FIND_ALLTool to retrieve insights from VAPI. Use when you need to list insights with optional filtering by ID, creation date, or update date. Supports pagination and sorting.

Input Parameters

string
Filter by insight ID
integer
Page number to return. Defaults to 1
integer
Maximum number of items to return. Defaults to 100
string ("ASC" | "DESC")
Sort order for pagination. Defaults to ‘DESC’
string
Return items where createdAt is greater than or equal to the specified value. Should be ISO 8601 datetime string
string
Return items where createdAt is greater than the specified value. Should be ISO 8601 datetime string
string
Return items where createdAt is less than or equal to the specified value. Should be ISO 8601 datetime string
string
Return items where createdAt is less than the specified value. Should be ISO 8601 datetime string
string
Return items where updatedAt is greater than or equal to the specified value. Should be ISO 8601 datetime string
string
Return items where updatedAt is greater than the specified value. Should be ISO 8601 datetime string
string
Return items where updatedAt is less than or equal to the specified value. Should be ISO 8601 datetime string
string
Return items where updatedAt is less than the specified value. Should be ISO 8601 datetime string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_LIST_ASSISTANTSTool to list all assistants in your VAPI organization. Use when you need to retrieve information about configured assistants. Supports filtering by creation and update timestamps.

Input Parameters

integer
Maximum number of assistants to return. If not specified, returns all assistants.
string
Filter for assistants created at or after this ISO 8601 date-time string.
string
Filter for assistants created after this ISO 8601 date-time string.
string
Filter for assistants created at or before this ISO 8601 date-time string.
string
Filter for assistants created before this ISO 8601 date-time string.
string
Filter for assistants updated at or after this ISO 8601 date-time string.
string
Filter for assistants updated after this ISO 8601 date-time string.
string
Filter for assistants updated at or before this ISO 8601 date-time string.
string
Filter for assistants updated before this ISO 8601 date-time string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_LIST_CHATSTool to retrieve a list of chat conversations from VAPI. Use when you need to view existing chats, optionally filtered by assistant, squad, session, or time range. Supports pagination and sorting for efficient retrieval of large chat histories.

Input Parameters

string
Filter by specific chat identifier
integer
Page number for pagination (defaults to 1)
integer
Maximum number of items to return (defaults to 100, max 1000)
string
Filter by squad identifier
string
Filter by session identifier
string
Sort direction: ASC or DESC (defaults to DESC)
string
Filter by assistant identifier
string
Filter chats created at or after this timestamp
string
Filter chats created after this timestamp
string
Filter chats created at or before this timestamp
string
Filter chats created before this timestamp
string
Filter chats updated at or after this timestamp
string
Filter chats updated after this timestamp
string
Filter chats updated at or before this timestamp
string
Filter chats updated before this timestamp
string
Filter by multiple assistant IDs (comma-separated)
string
Filter by previous chat identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_LIST_EVALSTool to retrieve a paginated list of evals from Vapi. Use when you need to list or search evals with optional filtering by creation/update timestamps.

Input Parameters

string
Filter by eval ID.
integer
Page number to return. Defaults to 1.
integer
Maximum number of items to return. Defaults to 100.
string ("ASC" | "DESC")
Sort order for pagination. Defaults to ‘DESC’.
string
Return items where createdAt is greater than or equal to the specified value.
string
Return items where createdAt is greater than the specified value.
string
Return items where createdAt is less than or equal to the specified value.
string
Return items where createdAt is less than the specified value.
string
Return items where updatedAt is greater than or equal to the specified value.
string
Return items where updatedAt is greater than the specified value.
string
Return items where updatedAt is less than or equal to the specified value.
string
Return items where updatedAt is less than the specified value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_LIST_PHONE_NUMBERSTool to list phone numbers in the Vapi organization. Use when you need to enumerate available phone numbers for routing or selection workflows. Supports filtering by creation and update timestamps.

Input Parameters

integer
Maximum number of phone numbers to return. Defaults to 100 if not specified.
string
Filter for phone numbers created at or after this ISO 8601 date-time string.
string
Filter for phone numbers created after this ISO 8601 date-time string.
string
Filter for phone numbers created at or before this ISO 8601 date-time string.
string
Filter for phone numbers created before this ISO 8601 date-time string.
string
Filter for phone numbers updated at or after this ISO 8601 date-time string.
string
Filter for phone numbers updated after this ISO 8601 date-time string.
string
Filter for phone numbers updated at or before this ISO 8601 date-time string.
string
Filter for phone numbers updated before this ISO 8601 date-time string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_LIST_PROVIDER_RESOURCESList Vapi provider pronunciation dictionaries for 11Labs or Cartesia, with optional ID and timestamp filters and pagination.

Input Parameters

string
Filter by resource ID.
integer
Page number to return. Defaults to 1.
integer
Maximum number of items to return. Defaults to 100.
string ("cartesia" | "11labs")
required
The provider to query resources from (e.g., ‘11labs’ or ‘cartesia’).
string ("ASC" | "DESC")
Sort order for pagination. Defaults to ‘DESC’.
string
Filter by provider’s resource ID.
string
Return items where createdAt is greater than or equal to the specified value.
string
Return items where createdAt is greater than the specified value.
string
Return items where createdAt is less than or equal to the specified value.
string
Return items where createdAt is less than the specified value.
string
required
The name of the resource type to query (e.g., ‘pronunciation-dictionary’).
string
Return items where updatedAt is greater than or equal to the specified value.
string
Return items where updatedAt is greater than the specified value.
string
Return items where updatedAt is less than or equal to the specified value.
string
Return items where updatedAt is less than the specified value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_PATCH_INSIGHT_INSIGHTUpdate an existing Vapi insight configuration, including its name, queries, time range, or visualization settings. An insight type and at least one query must be supplied on every update; bar, pie, line, and text types are accepted.

Input Parameters

string
required
Unique identifier of the insight to update
string
Display name for the insight
string ("bar" | "pie" | "line" | "text")
required
Type of insight visualization: ‘bar’ for bar chart, ‘pie’ for pie chart, ‘line’ for line chart, ‘text’ for text/numeric display
object
Single formula object for text insights when using multiple queries
string ("assistantId" | "workflowId" | "squadId" | "phoneNumberId" | "type" | "endedReason" | "campaignId")
Field to group results by. Use for breaking down data by specific dimensions. Can also use ‘artifact.structuredOutputs[OutputID]’ format
array
required
Array of query definitions. Text insights with multiple queries require a formula. Other types support multiple queries
array
Array of formulas for computed values. Available for bar, pie, and line insights
object
Metadata for chart configuration (bar and line insights only).
string
Time range for the insight data. Bar and line insights support ‘step’ field for granularity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_PHONE_NUMBER_CONTROLLER_CREATETool to create a phone number with VAPI. Use when you need to provision a new phone number for voice AI applications. Supports multiple providers (VAPI, Twilio, Vonage, Telnyx, BYO). Required parameters vary by provider.

Input Parameters

string
Friendly name for the phone number for your reference
string
Phone number in E.164 format. Required for Twilio, Vonage, and Telnyx providers. Not used for VAPI provider
string
SIP URI for the phone number. Only applicable for VAPI provider
string ("byo-phone-number" | "twilio" | "vonage" | "vapi" | "telnyx")
required
Phone number provider. Required for all phone number creations. Options: ‘byo-phone-number’ (bring your own), ‘twilio’, ‘vonage’, ‘vapi’, or ‘telnyx’
string
ID of the squad to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set
boolean
Enable SMS functionality for the phone number. Only applicable for Twilio provider
string
ID of the workflow to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set
string
ID of the assistant to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set
string
Credential ID for authentication. Required for BYO (bring your own), Vonage, and Telnyx providers. Not used for VAPI or Twilio providers
string
Twilio API Key. Optional when using Twilio provider
string
Twilio API Secret. Optional when using Twilio provider
string
Twilio Auth Token for authentication. Optional when using Twilio provider
string
Twilio Account SID. Required only when using Twilio provider
string
Desired area code for the phone number when using VAPI provider to automatically provision a number
boolean
Enable E.164 format validation for phone numbers. Only applicable for BYO provider

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_SCORECARD_CONTROLLER_GET_PAGINATEDTool to retrieve a paginated list of scorecards from Vapi. Use when you need to list or search scorecards with optional filtering by creation/update timestamps.

Input Parameters

string
Filter by scorecard identifier.
integer
Page number to return. Defaults to 1.
integer
Maximum number of items to return. Defaults to 100.
string ("ASC" | "DESC")
Sort order for pagination. Defaults to ‘DESC’.
string
Return items where createdAt is greater than or equal to the specified value. Use ISO 8601 datetime format.
string
Return items where createdAt is greater than the specified value. Use ISO 8601 datetime format.
string
Return items where createdAt is less than or equal to the specified value. Use ISO 8601 datetime format.
string
Return items where createdAt is less than the specified value. Use ISO 8601 datetime format.
string
Return items where updatedAt is greater than or equal to the specified value. Use ISO 8601 datetime format.
string
Return items where updatedAt is greater than the specified value. Use ISO 8601 datetime format.
string
Return items where updatedAt is less than or equal to the specified value. Use ISO 8601 datetime format.
string
Return items where updatedAt is less than the specified value. Use ISO 8601 datetime format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_SESSION_CONTROLLER_CREATETool to create a new session in Vapi. Use when you need to establish a persistent conversation context that can span multiple chats. Sessions automatically expire after 24 hours.

Input Parameters

string
Name of the session for easy reference. Maximum length is 40 characters.
object
Inline assistant configuration for session creation.
string
ID of a pre-configured assistant to use. Provide either assistantId or assistant object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_SESSION_CONTROLLER_FIND_ALL_PAGINATEDTool to retrieve a paginated list of sessions from VAPI. Use when you need to list sessions with optional filtering by session ID, name, assistant, squad, or workflow. Supports pagination, sorting, and timestamp-based filtering.

Input Parameters

string
Unique identifier for the session to filter by
string
Name of the session to filter by
integer
Page number for results; defaults to 1
integer
Maximum items to return; defaults to 100
string
ID of the squad to filter sessions by
string ("ASC" | "DESC")
Sort order (ASC/DESC); defaults to DESC
string
ID of the workflow to filter sessions by
string
ID of the assistant to filter sessions by
string
Items where createdAt is greater than or equal to value. Use ISO 8601 datetime format
string
Items where createdAt is greater than specified value. Use ISO 8601 datetime format
string
Items where createdAt is less than or equal to value. Use ISO 8601 datetime format
string
Items where createdAt is less than specified value. Use ISO 8601 datetime format
string
Items where updatedAt is greater than or equal to value. Use ISO 8601 datetime format
string
Items where updatedAt is greater than specified value. Use ISO 8601 datetime format
string
Items where updatedAt is less than or equal to value. Use ISO 8601 datetime format
string
Items where updatedAt is less than specified value. Use ISO 8601 datetime format
string
Filter by multiple assistant IDs. Provide as comma-separated values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_TOOL_CONTROLLER_FIND_ONEFetch a Vapi tool by ID and return selected configuration details, including type, messages, function definition, and server settings.

Input Parameters

string
required
The unique identifier of the tool to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_TOOL_CONTROLLER_TEST_CODE_EXECUTIONTool to test TypeScript code execution in Vapi’s code tool environment. Use when validating code before deploying it as a tool.

Input Parameters

string
required
TypeScript code to execute. The code should return a result object. Can access ‘args’ for parameters and ‘env’ for environment variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_TOOL_CONTROLLER_UPDATETool to update an existing Vapi tool configuration. Use when you need to modify tool properties such as function definitions, server settings, messages, or other tool-specific parameters.

Input Parameters

string
required
The unique identifier of the tool to update
string
URL endpoint for apiRequest tools
string
Type of tool: function, apiRequest, dtmf, endCall, transferCall, handoff, bash, computer, textEditor, query, google.calendar.event.create, google.sheets.row.append, slack.message.send, sms, mcp, or gohighlevel variants
boolean
Whether the tool execution is asynchronous
string
HTTP method for apiRequest tools: GET, POST, PATCH, PUT, DELETE
object
Server configuration for tool requests including url, timeout, headers, and credentials
object
Function definition for function-type tools.
array
Array of message objects for different tool states: ToolMessageStart, ToolMessageComplete, ToolMessageFailed, ToolMessageDelayed
object
Retry logic configuration with type, maxRetries, and baseDelaySeconds
array
Transfer destinations for transferCall tools
object
Conditions determining when the tool should be rejected or not executed
object
Schema and aliases for extracting variables from the call for use in the tool

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_UPDATE_PHONE_NUMBERTool to update an existing phone number configuration in VAPI. Use when you need to modify phone number settings such as name, associated assistant/workflow, or provider-specific configurations.

Input Parameters

string
required
The unique identifier of the phone number to update. This is the phone number ID returned from VAPI.
string
The name or label for the phone number to help identify it.
array
List of webhook configurations to receive events for this phone number.
string
The actual phone number in E.164 format (e.g., +14155551234).
object
Server configuration for handling phone number events.
string
SIP URI for SIP-based phone numbers.
string
The ID of the squad to associate with this phone number. Alternative to assistant_id or workflow_id.
boolean
Whether SMS is enabled for this phone number (Twilio provider only).
string
The ID of the workflow to associate with this phone number. Alternative to assistant_id.
string
The ID of the assistant to associate with this phone number. When calls are received, this assistant will handle them.
string
The ID of the credential to use for this phone number (provider-specific).
object
Authentication configuration for SIP-based phone numbers.
string
Twilio API key (alternative to auth token).
string
Twilio API secret (used with API key).
string
Twilio authentication token (for Twilio provider).
string
Twilio account SID (required for Twilio provider).
object
Fallback destination configuration when the primary assistant/workflow is unavailable.
boolean
Whether to enable E.164 format validation for the phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VAPI_UPLOAD_FILETool to upload a file to Vapi Knowledge Base. Use when you need to add files for AI assistants to reference. Returns file metadata including ID, storage URLs, and processing status.

Input Parameters

object
required
File to upload to Vapi Knowledge Base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not