NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Vapi

vapi

Vapi is a voice AI platform that enables developers to build, test, and deploy voice agents with natural conversations, real-time responses, and seamless integration capabilities.

Artificial IntelligenceDeveloper ToolsWeb del proveedor
Acciones
42
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (42)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Update AssistantVAPI_ASSISTANT_CONTROLLER_UPDATEAcción

Tool 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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the assistant to update

  • namestring

    The name of the assistant

  • modelobject

    Configuration for the LLM model used by the assistant. Includes provider, model name, temperature, and other model-specific settings

  • voiceobject

    Configuration for the text-to-speech voice. Supports providers like ElevenLabs, PlayHT, Rime, Azure, Cartesia, etc.

  • metadataobject

    Custom metadata object to attach to the assistant. Can contain any key-value pairs for your use

  • server_urlstring

    Server URL where assistant events and messages will be sent

  • transcriberobject

    Configuration for the speech-to-text transcriber. Supports multiple providers like AssemblyAI, Deepgram, Google, Azure, etc. Each provider has specific configuration options

  • message_planobject

    Configuration for messages to be sent to client and server during the call

  • monitor_planobject

    Configuration for monitoring the assistant during calls

  • analysis_planobject

    Configuration for post-call analysis including summary, structured data extraction, and success evaluation

  • artifact_planobject

    Configuration for artifacts (recordings, transcripts) to be created during or after the call

  • first_messagestring

    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

  • hipaa_enabledboolean

    Whether HIPAA compliance is enabled for the assistant

  • credential_idsstring[]

    List of credential IDs the assistant should use for various integrations

  • client_messagesstring[]

    List of message types to send to client SDKs

  • server_messagesstring[]

    List of message types to send to server URL

  • background_soundstring

    Background sound in the call. Options: 'off', 'office'. Default is 'office' for phone calls and 'off' for web calls

  • end_call_messagestring

    Message the assistant will say before ending the call

  • end_call_phrasesstring[]

    Phrases that will trigger the end of the call when spoken by the user

  • max_duration_planobject

    Configuration for handling maximum call duration

  • server_url_secretstring

    Secret used to authenticate requests to the server URL

  • voicemail_messagestring

    Message the assistant will say if the call goes to voicemail

  • first_message_modestring

    Mode for the first message. Options: 'assistant-speaks-first', 'assistant-waits-for-user'. Default is 'assistant-speaks-first'

  • stop_speaking_planobject

    Plan for when the assistant should stop talking

  • backchannel_enabledboolean

    Whether backchannel (verbal acknowledgments like 'uh-huh', 'mm-hmm') is enabled

  • start_speaking_planobject

    Plan for when the assistant should start talking, useful for addressing timing and latency issues

  • max_duration_secondsinteger

    Maximum number of seconds the call will last, after which it will be ended

  • response_delay_secondsnumber

    Delay in seconds before the assistant responds

  • silence_timeout_secondsinteger

    Number of seconds of silence before the call is ended

  • transport_configurationsobject[]

    Configuration for transport protocols (SIP, WebRTC, etc.)

  • llm_request_delay_secondsnumber

    Delay in seconds before making LLM requests

  • background_denoising_enabledboolean

    Whether background noise filtering is enabled

  • model_output_in_messages_enabledboolean

    Whether to include model output in messages sent to client/server

  • num_words_to_interrupt_assistantinteger

    Number of words user needs to speak to interrupt the assistant

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CallsVAPI_CALL_CONTROLLER_FIND_ALLAcción

Tool 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.

Parámetros de entrada

  • idstring

    Unique call identifier. Use to filter for a specific call.

  • limitinteger

    Maximum number of items to return. Defaults to 100 if not specified. Must be between 0 and 1000.

  • assistantIdstring

    Returns calls with the specified assistantId. Use to filter calls by assistant.

  • createdAtGestring

    Returns items where createdAt meets or exceeds the specified value. Use ISO 8601 date-time format (e.g., '2024-01-01T00:00:00Z').

  • createdAtGtstring

    Returns items where createdAt exceeds the specified value. Use ISO 8601 date-time format (e.g., '2024-01-01T00:00:00Z').

  • createdAtLestring

    Returns items where createdAt is at or below the specified value. Use ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z').

  • createdAtLtstring

    Returns items where createdAt is below the specified value. Use ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z').

  • updatedAtGestring

    Returns items where updatedAt meets or exceeds the specified value. Use ISO 8601 date-time format (e.g., '2024-01-01T00:00:00Z').

  • updatedAtGtstring

    Returns items where updatedAt exceeds the specified value. Use ISO 8601 date-time format (e.g., '2024-01-01T00:00:00Z').

  • updatedAtLestring

    Returns items where updatedAt is at or below the specified value. Use ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z').

  • updatedAtLtstring

    Returns items where updatedAt is below the specified value. Use ISO 8601 date-time format (e.g., '2024-12-31T23:59:59Z').

  • phoneNumberIdstring

    Phone number for the call; for outbound/inbound phone calls only. Use to filter calls by phone number.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ChatVAPI_CHAT_CONTROLLER_DELETE_CHATAcción

Tool to delete a chat by its ID from Vapi. Use when you need to permanently remove a chat conversation.

Parámetros de entrada

  • idstringObligatorio

    The chat identifier to be deleted

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ChatVAPI_CHAT_CONTROLLER_GET_CHATAcción

Tool to fetch chat details by ID. Use when you have a chat ID and need full chat information including messages, costs, and configuration.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the chat to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Analytics QueriesVAPI_CREATE_ANALYTICS_QUERYAcción

Tool 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.

Parámetros de entrada

  • queriesobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create AssistantVAPI_CREATE_ASSISTANTAcción

Tool 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.

Parámetros de entrada

  • namestring

    Assistant identifier/name for easy reference and organization

  • modelobjectObligatorio

    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.

  • voiceobjectObligatorio

    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.

  • transcriberobjectObligatorio

    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.

  • firstMessagestring

    Initial greeting message the assistant will say when the conversation starts

  • systemPromptstring

    Instructions for AI behavior and personality. Alternative to including system message in model.messages field.

  • clientMessagesstring[]

    List of message types to relay to the client application

  • serverMessagesstring[]

    List of message types to send to the server webhook

  • maxDurationSecondsinteger

    Maximum call duration in seconds before automatic termination

  • voicemailDetectionobject

    Voicemail detection configuration.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create EvalVAPI_CREATE_EVALAcción

Tool to create an eval for testing conversation flows. Use when you need to validate that an AI assistant responds correctly to specific conversation scenarios.

Parámetros de entrada

  • namestring

    Name of the eval to help identify what the eval is checking for

  • typestringObligatorio

    Type of the eval. Currently fixed to 'chat.mockConversation'

  • messagesobject[]Obligatorio

    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

  • descriptionstring

    Description of the eval and its purpose in detail. Not used to evaluate the conversation flow

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create OpenAI ChatVAPI_CREATE_OPEN_AI_CHATAcción

Tool to create an OpenAI-compatible chat using the Vapi API. Use when you need to send a chat message to an assistant or squad and receive a response. Supports both streaming and non-streaming modes.

Parámetros de entrada

  • namestring

    The name of the chat. This is just for your own reference.

  • inputanyObligatorio

    The input text for the chat. Can be a string or an array of chat messages. This field is required for chat creation.

  • squadobject

    The squad configuration object that will be used for the chat. Use this to define a transient squad. Mutually exclusive with 'squadId' field.

  • streamboolean

    Whether to stream the response or not. Defaults to true.

  • squadIdstring

    The squad ID that will be used for the chat. Use this to reference an existing squad. Mutually exclusive with 'squad' field.

  • assistantobject

    The assistant configuration object that will be used for the chat. Use this to define a transient assistant. Mutually exclusive with 'assistantId' field.

  • sessionIdstring

    The ID of the session that will be used for the chat. Mutually exclusive with 'previousChatId' and transport fields (phoneNumberId/customer).

  • transportobject

    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.

  • assistantIdstring

    The assistant ID that will be used for the chat. Use this to reference an existing assistant. Mutually exclusive with 'assistant' field.

  • previousChatIdstring

    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'.

  • assistantOverridesobject

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Phone NumberVAPI_CREATE_PHONE_NUMBERAcción

Tool to create a phone number with Vapi. Supports multiple providers including byo-phone-number, twilio, vonage, vapi, and telnyx. Use this to provision new phone numbers for handling voice calls. For vapi provider, only provider field is required; other fields are optional based on provider type.

Parámetros de entrada

  • namestring

    Name for reference. Optional field to give a human-readable name to this phone number for easier identification.

  • numberstring

    Phone number in E.164 format (e.g., +1234567890). Required for twilio, vonage, and telnyx providers. Optional for byo-phone-number.

  • squadIdstring

    Squad ID for incoming calls. When provided, incoming calls to this phone number will be handled by this squad. Mutually exclusive with assistantId and workflowId.

  • providerstringObligatorioenum

    Phone number provider type. Required for all phone number types.

    byo-phone-numbertwiliovonagevapitelnyx
  • workflowIdstring

    Workflow ID for incoming calls. When provided, incoming calls to this phone number will be handled by this workflow. Mutually exclusive with assistantId and squadId.

  • assistantIdstring

    Assistant ID for incoming calls. When provided, incoming calls to this phone number will be handled by this assistant. Mutually exclusive with squadId and workflowId.

  • credentialIdstring

    Credential ID. Required for byo-phone-number, vonage, and telnyx providers. This credential identifies the authentication to use with the provider.

  • twilioAccountSidstring

    Twilio Account SID. Required when using twilio provider. This identifies your Twilio account.

  • numberDesiredAreaCodestring

    Desired area code for vapi provider. Only applicable when provider is 'vapi'. Vapi will attempt to provision a phone number with this area code.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Monitoring PolicyVAPI_CREATE_POLICYAcción

Tool 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.

Parámetros de entrada

  • namestringObligatorio

    Policy identifier name. This should be a descriptive name for the policy.

  • intervalobject

    Interval-based scheduling configuration for policy execution.

  • scheduleobject

    Cron-like scheduling configuration for policy execution.

  • severitystringObligatorioenum

    Severity level of the policy. Use 'error' for critical issues, 'warning' for concerning patterns, or 'info' for informational alerts.

    errorwarninginfo
  • thresholdobjectObligatorio

    Threshold configuration that defines when the policy should trigger.

  • monitorIdsstring[]

    List of monitor identifiers to associate with this policy.

  • lookbackWindowMinutesintegerObligatorio

    Time window in minutes for querying events. This defines how far back to look when evaluating the policy.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Provider ResourceVAPI_CREATE_PROVIDER_RESOURCEAcción

Tool to create an 11Labs pronunciation dictionary resource. Use when you need to define custom pronunciations for specific terms or acronyms in voice synthesis.

Parámetros de entrada

  • namestringObligatorio

    Name of the pronunciation dictionary to create.

  • rulesarrayObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ScorecardVAPI_CREATE_SCORECARDAcción

Tool 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.

Parámetros de entrada

  • namestring

    Name of the scorecard for user reference. This is not used for any evaluation, only for identification purposes.

  • metricsobject[]Obligatorio

    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.

  • descriptionstring

    Description of the scorecard for user reference. This is not used for any evaluation.

  • assistantIdsstring[]

    Assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants' calls.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CallVAPI_DELETE_CALLAcción

Tool to delete a call by its unique identifier. Use when you need to remove call data from the system. Returns the deleted call object with all its associated data.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the call to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete EvalVAPI_DELETE_EVALAcción

Tool to delete an eval by ID. Use when you need to permanently remove an eval from the system.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the eval to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Phone NumberVAPI_DELETE_PHONE_NUMBERAcción

Tool to delete a phone number from Vapi. Use when you need to remove a phone number from your Vapi organization. Returns the deleted phone number object.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier for the phone number to be removed.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get EvalVAPI_EVAL_CONTROLLER_GETAcción

Tool 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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the eval to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Eval RunVAPI_EVAL_CONTROLLER_REMOVE_RUNAcción

Tool to delete an eval run by its ID from Vapi. Use when you need to permanently remove an evaluation run.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the eval run to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update EvalVAPI_EVAL_CONTROLLER_UPDATEAcción

Tool to update an existing eval in Vapi. Use when you need to modify eval properties like name, description, type, or mock conversation messages.

Parámetros de entrada

  • idstringObligatorio

    The ID of the eval to update

  • namestring

    This is the name of the eval. It helps identify what the eval is checking for.

  • typestring

    This is the type of the eval. Currently it is fixed to 'chat.mockConversation'.

  • messagesobject[]

    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.

  • descriptionstring

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AssistantVAPI_GET_ASSISTANTAcción

Tool to retrieve a specific assistant by ID from Vapi. Use when you need to fetch details about an existing assistant.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the assistant to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CallVAPI_GET_CALLAcción

Tool to fetch call details by ID. Use when you have a call ID and need full call information including status, duration, costs, messages, and recordings.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the call to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FileVAPI_GET_FILEAcción

Tool 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.

Parámetros de entrada

  • idstringObligatorio

    Identifier for the file to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get InsightsVAPI_GET_INSIGHTAcción

Tool to retrieve insights from Vapi. Use when you need to fetch insight data with optional filtering by ID, timestamps, or pagination. Returns a paginated list of insights with metadata.

Parámetros de entrada

  • idstring

    Filter by specific insight ID to retrieve a single insight

  • pageinteger

    Page number to return for paginated results. Defaults to 1 if not specified

  • limitinteger

    Maximum number of insights to return per page. Defaults to 100 if not specified

  • sortOrderstringenum

    Sort order for pagination results. ASC for ascending, DESC for descending. Defaults to DESC if not specified

    ASCDESC
  • createdAtGestring

    Filter insights created on or after this timestamp (greater than or equal). Use ISO 8601 datetime format

  • createdAtGtstring

    Filter insights created after this timestamp (greater than). Use ISO 8601 datetime format

  • createdAtLestring

    Filter insights created on or before this timestamp (less than or equal). Use ISO 8601 datetime format

  • createdAtLtstring

    Filter insights created before this timestamp (less than). Use ISO 8601 datetime format

  • updatedAtGestring

    Filter insights updated on or after this timestamp (greater than or equal). Use ISO 8601 datetime format

  • updatedAtGtstring

    Filter insights updated after this timestamp (greater than). Use ISO 8601 datetime format

  • updatedAtLestring

    Filter insights updated on or before this timestamp (less than or equal). Use ISO 8601 datetime format

  • updatedAtLtstring

    Filter insights updated before this timestamp (less than). Use ISO 8601 datetime format

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Monitoring PoliciesVAPI_GET_MONITORINGAcción

Tool 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.

Parámetros de entrada

  • idstring

    Returns policies with the specified id

  • pageinteger

    Page number for pagination (defaults to 1)

  • limitinteger

    Maximum number of items returned per page (defaults to 100)

  • severitystringenum

    Filters by severity level. Must be one of: error, warning, or info

    errorwarninginfo
  • monitor_idstring

    Returns policies associated with the specified monitor ID

  • sort_orderstringenum

    Sort order for pagination. Must be either ASC or DESC (defaults to DESC)

    ASCDESC
  • created_at_gestring

    Filter to return items where createdAt is greater than or equal to this ISO 8601 date-time value

  • created_at_gtstring

    Filter to return items where createdAt is greater than this ISO 8601 date-time value

  • created_at_lestring

    Filter to return items where createdAt is less than or equal to this ISO 8601 date-time value

  • created_at_ltstring

    Filter to return items where createdAt is less than this ISO 8601 date-time value

  • updated_at_gestring

    Filter to return items where updatedAt is greater than or equal to this ISO 8601 date-time value

  • updated_at_gtstring

    Filter to return items where updatedAt is greater than this ISO 8601 date-time value

  • updated_at_lestring

    Filter to return items where updatedAt is less than or equal to this ISO 8601 date-time value

  • updated_at_ltstring

    Filter to return items where updatedAt is less than this ISO 8601 date-time value

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Observability ScorecardVAPI_GET_OBSERVABILITY_SCORECARDAcción

Tool to list observability scorecards with optional filtering and pagination. Use when you need to retrieve scorecards for monitoring or analysis.

Parámetros de entrada

  • idstring

    Filter by scorecard identifier

  • pageinteger

    Page number to return. Defaults to 1.

  • limitinteger

    Maximum number of items to return. Defaults to 100.

  • sortOrderstring

    Sort direction (ASC or DESC). Defaults to DESC.

  • createdAtGestring

    Items where createdAt meets or exceeds specified value (ISO 8601 date-time)

  • createdAtGtstring

    Items where createdAt exceeds specified value (ISO 8601 date-time)

  • createdAtLestring

    Items where createdAt is at or below specified value (ISO 8601 date-time)

  • createdAtLtstring

    Items where createdAt is below specified value (ISO 8601 date-time)

  • updatedAtGestring

    Items where updatedAt meets or exceeds specified value (ISO 8601 date-time)

  • updatedAtGtstring

    Items where updatedAt exceeds specified value (ISO 8601 date-time)

  • updatedAtLestring

    Items where updatedAt is at or below specified value (ISO 8601 date-time)

  • updatedAtLtstring

    Items where updatedAt is below specified value (ISO 8601 date-time)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Provider ResourcesVAPI_GET_PROVIDER_RESOURCESAcción

Tool to list provider resources from Vapi. Use when you need to retrieve pronunciation dictionaries or other resources from providers like 11labs or Cartesia.

Parámetros de entrada

  • idstring

    Resource identifier to filter by

  • pageinteger

    Page number for pagination (defaults to 1, minimum: 1)

  • limitinteger

    Maximum items to return (defaults to 100, range: 0-1000)

  • providerstringObligatorio

    The provider identifier (e.g., '11labs', 'cartesia')

  • sort_orderstringenum

    Sort direction: ASC or DESC (defaults to DESC)

    ASCDESC
  • resource_idstring

    Provider-specific resource identifier to filter by

  • created_at_gtstring

    Filter by creation date greater than (ISO 8601 date-time format)

  • created_at_ltstring

    Filter by creation date less than (ISO 8601 date-time format)

  • resource_namestringObligatorio

    The resource type (e.g., 'pronunciation-dictionary')

  • updated_at_gtstring

    Filter by update date greater than (ISO 8601 date-time format)

  • updated_at_ltstring

    Filter by update date less than (ISO 8601 date-time format)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Structured OutputsVAPI_GET_STRUCTURED_OUTPUTSAcción

Tool 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.

Parámetros de entrada

  • idstring

    Filters results where the identifier matches the specified value

  • namestring

    Filters results where the name matches the specified value

  • pageinteger

    Page number for results (defaults to 1)

  • limitinteger

    Maximum items returned per request (defaults to 100)

  • sortOrderstring

    Sort direction for pagination. Must be 'ASC' or 'DESC' (defaults to DESC)

  • createdAtGestring

    Returns items created on or after the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • createdAtGtstring

    Returns items created after the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • createdAtLestring

    Returns items created on or before the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • createdAtLtstring

    Returns items created before the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • updatedAtGestring

    Returns items updated on or after the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • updatedAtGtstring

    Returns items updated after the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • updatedAtLestring

    Returns items updated on or before the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

  • updatedAtLtstring

    Returns items updated before the specified timestamp. Must be in ISO 8601 date-time format (e.g., '2024-01-15T10:30:00Z')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get InsightsVAPI_INSIGHT_CONTROLLER_FIND_ALLAcción

Tool 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.

Parámetros de entrada

  • idstring

    Filter by insight ID

  • pageinteger

    Page number to return. Defaults to 1

  • limitinteger

    Maximum number of items to return. Defaults to 100

  • sortOrderstringenum

    Sort order for pagination. Defaults to 'DESC'

    ASCDESC
  • createdAtGestring

    Return items where createdAt is greater than or equal to the specified value. Should be ISO 8601 datetime string

  • createdAtGtstring

    Return items where createdAt is greater than the specified value. Should be ISO 8601 datetime string

  • createdAtLestring

    Return items where createdAt is less than or equal to the specified value. Should be ISO 8601 datetime string

  • createdAtLtstring

    Return items where createdAt is less than the specified value. Should be ISO 8601 datetime string

  • updatedAtGestring

    Return items where updatedAt is greater than or equal to the specified value. Should be ISO 8601 datetime string

  • updatedAtGtstring

    Return items where updatedAt is greater than the specified value. Should be ISO 8601 datetime string

  • updatedAtLestring

    Return items where updatedAt is less than or equal to the specified value. Should be ISO 8601 datetime string

  • updatedAtLtstring

    Return items where updatedAt is less than the specified value. Should be ISO 8601 datetime string

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AssistantsVAPI_LIST_ASSISTANTSAcción

Tool 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.

Parámetros de entrada

  • limitinteger

    Maximum number of assistants to return. If not specified, returns all assistants.

  • createdAtGestring

    Filter for assistants created at or after this ISO 8601 date-time string.

  • createdAtGtstring

    Filter for assistants created after this ISO 8601 date-time string.

  • createdAtLestring

    Filter for assistants created at or before this ISO 8601 date-time string.

  • createdAtLtstring

    Filter for assistants created before this ISO 8601 date-time string.

  • updatedAtGestring

    Filter for assistants updated at or after this ISO 8601 date-time string.

  • updatedAtGtstring

    Filter for assistants updated after this ISO 8601 date-time string.

  • updatedAtLestring

    Filter for assistants updated at or before this ISO 8601 date-time string.

  • updatedAtLtstring

    Filter for assistants updated before this ISO 8601 date-time string.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ChatsVAPI_LIST_CHATSAcción

Tool 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.

Parámetros de entrada

  • idstring

    Filter by specific chat identifier

  • pageinteger

    Page number for pagination (defaults to 1)

  • limitinteger

    Maximum number of items to return (defaults to 100, max 1000)

  • squad_idstring

    Filter by squad identifier

  • session_idstring

    Filter by session identifier

  • sort_orderstring

    Sort direction: ASC or DESC (defaults to DESC)

  • assistant_idstring

    Filter by assistant identifier

  • created_at_gestring

    Filter chats created at or after this timestamp

  • created_at_gtstring

    Filter chats created after this timestamp

  • created_at_lestring

    Filter chats created at or before this timestamp

  • created_at_ltstring

    Filter chats created before this timestamp

  • updated_at_gestring

    Filter chats updated at or after this timestamp

  • updated_at_gtstring

    Filter chats updated after this timestamp

  • updated_at_lestring

    Filter chats updated at or before this timestamp

  • updated_at_ltstring

    Filter chats updated before this timestamp

  • assistant_id_anystring

    Filter by multiple assistant IDs (comma-separated)

  • previous_chat_idstring

    Filter by previous chat identifier

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List EvalsVAPI_LIST_EVALSAcción

Tool 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.

Parámetros de entrada

  • idstring

    Filter by eval ID.

  • pageinteger

    Page number to return. Defaults to 1.

  • limitinteger

    Maximum number of items to return. Defaults to 100.

  • sort_orderstringenum

    Sort order for pagination. Defaults to 'DESC'.

    ASCDESC
  • created_at_gestring

    Return items where createdAt is greater than or equal to the specified value.

  • created_at_gtstring

    Return items where createdAt is greater than the specified value.

  • created_at_lestring

    Return items where createdAt is less than or equal to the specified value.

  • created_at_ltstring

    Return items where createdAt is less than the specified value.

  • updated_at_gestring

    Return items where updatedAt is greater than or equal to the specified value.

  • updated_at_gtstring

    Return items where updatedAt is greater than the specified value.

  • updated_at_lestring

    Return items where updatedAt is less than or equal to the specified value.

  • updated_at_ltstring

    Return items where updatedAt is less than the specified value.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Provider ResourcesVAPI_LIST_PROVIDER_RESOURCESAcción

Tool to retrieve provider resources from Vapi (e.g., 11labs pronunciation dictionaries). Use when you need to list or search provider-specific resources with optional filtering by timestamps.

Parámetros de entrada

  • idstring

    Filter by resource ID.

  • pageinteger

    Page number to return. Defaults to 1.

  • limitinteger

    Maximum number of items to return. Defaults to 100.

  • providerstringObligatorioenum

    The provider to query resources from (e.g., '11labs' or 'cartesia').

    cartesia11labs
  • sort_orderstringenum

    Sort order for pagination. Defaults to 'DESC'.

    ASCDESC
  • resource_idstring

    Filter by provider's resource ID.

  • created_at_gestring

    Return items where createdAt is greater than or equal to the specified value.

  • created_at_gtstring

    Return items where createdAt is greater than the specified value.

  • created_at_lestring

    Return items where createdAt is less than or equal to the specified value.

  • created_at_ltstring

    Return items where createdAt is less than the specified value.

  • resource_namestringObligatorio

    The name of the resource type to query (e.g., 'pronunciation-dictionary').

  • updated_at_gestring

    Return items where updatedAt is greater than or equal to the specified value.

  • updated_at_gtstring

    Return items where updatedAt is greater than the specified value.

  • updated_at_lestring

    Return items where updatedAt is less than or equal to the specified value.

  • updated_at_ltstring

    Return items where updatedAt is less than the specified value.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update InsightVAPI_PATCH_INSIGHT_INSIGHTAcción

Tool to update an existing insight configuration in VAPI. Use when you need to modify insight properties like name, queries, time range, or visualization settings. Supports all four insight types (bar, pie, line, text) with type-specific configurations.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the insight to update

  • namestring

    Display name for the insight

  • typestringObligatorioenum

    Type of insight visualization: 'bar' for bar chart, 'pie' for pie chart, 'line' for line chart, 'text' for text/numeric display

    barpielinetext
  • formulaobject

    Single formula object for text insights when using multiple queries

  • groupBystringenum

    Field to group results by. Use for breaking down data by specific dimensions. Can also use 'artifact.structuredOutputs[OutputID]' format

    assistantIdworkflowIdsquadIdphoneNumberIdtypeendedReasoncampaignId
  • queriesobject[]Obligatorio

    Array of query definitions. Text insights with multiple queries require a formula. Other types support multiple queries

  • formulasobject[]

    Array of formulas for computed values. Available for bar, pie, and line insights

  • metadataobject

    Metadata for chart configuration (bar and line insights only).

  • timeRangeany

    Time range for the insight data. Bar and line insights support 'step' field for granularity

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Phone NumberVAPI_PHONE_NUMBER_CONTROLLER_CREATEAcción

Tool 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.

Parámetros de entrada

  • namestring

    Friendly name for the phone number for your reference

  • numberstring

    Phone number in E.164 format. Required for Twilio, Vonage, and Telnyx providers. Not used for VAPI provider

  • sip_uristring

    SIP URI for the phone number. Only applicable for VAPI provider

  • providerstringObligatorioenum

    Phone number provider. Required for all phone number creations. Options: 'byo-phone-number' (bring your own), 'twilio', 'vonage', 'vapi', or 'telnyx'

    byo-phone-numbertwiliovonagevapitelnyx
  • squad_idstring

    ID of the squad to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set

  • sms_enabledboolean

    Enable SMS functionality for the phone number. Only applicable for Twilio provider

  • workflow_idstring

    ID of the workflow to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set

  • assistant_idstring

    ID of the assistant to associate with this phone number. Only one of assistantId, squadId, or workflowId can be set

  • credential_idstring

    Credential ID for authentication. Required for BYO (bring your own), Vonage, and Telnyx providers. Not used for VAPI or Twilio providers

  • twilio_api_keystring

    Twilio API Key. Optional when using Twilio provider

  • twilio_api_secretstring

    Twilio API Secret. Optional when using Twilio provider

  • twilio_auth_tokenstring

    Twilio Auth Token for authentication. Optional when using Twilio provider

  • twilio_account_sidstring

    Twilio Account SID. Required only when using Twilio provider

  • number_desired_area_codestring

    Desired area code for the phone number when using VAPI provider to automatically provision a number

  • number_e164_check_enabledboolean

    Enable E.164 format validation for phone numbers. Only applicable for BYO provider

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ScorecardsVAPI_SCORECARD_CONTROLLER_GET_PAGINATEDAcción

Tool 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.

Parámetros de entrada

  • idstring

    Filter by scorecard identifier.

  • pageinteger

    Page number to return. Defaults to 1.

  • limitinteger

    Maximum number of items to return. Defaults to 100.

  • sortOrderstringenum

    Sort order for pagination. Defaults to 'DESC'.

    ASCDESC
  • createdAtGestring

    Return items where createdAt is greater than or equal to the specified value. Use ISO 8601 datetime format.

  • createdAtGtstring

    Return items where createdAt is greater than the specified value. Use ISO 8601 datetime format.

  • createdAtLestring

    Return items where createdAt is less than or equal to the specified value. Use ISO 8601 datetime format.

  • createdAtLtstring

    Return items where createdAt is less than the specified value. Use ISO 8601 datetime format.

  • updatedAtGestring

    Return items where updatedAt is greater than or equal to the specified value. Use ISO 8601 datetime format.

  • updatedAtGtstring

    Return items where updatedAt is greater than the specified value. Use ISO 8601 datetime format.

  • updatedAtLestring

    Return items where updatedAt is less than or equal to the specified value. Use ISO 8601 datetime format.

  • updatedAtLtstring

    Return items where updatedAt is less than the specified value. Use ISO 8601 datetime format.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create SessionVAPI_SESSION_CONTROLLER_CREATEAcción

Tool 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.

Parámetros de entrada

  • namestring

    Name of the session for easy reference. Maximum length is 40 characters.

  • assistantobject

    Inline assistant configuration for session creation.

  • assistantIdstring

    ID of a pre-configured assistant to use. Provide either assistantId or assistant object.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SessionsVAPI_SESSION_CONTROLLER_FIND_ALL_PAGINATEDAcción

Tool 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.

Parámetros de entrada

  • idstring

    Unique identifier for the session to filter by

  • namestring

    Name of the session to filter by

  • pageinteger

    Page number for results; defaults to 1

  • limitinteger

    Maximum items to return; defaults to 100

  • squadIdstring

    ID of the squad to filter sessions by

  • sortOrderstringenum

    Sort order (ASC/DESC); defaults to DESC

    ASCDESC
  • workflowIdstring

    ID of the workflow to filter sessions by

  • assistantIdstring

    ID of the assistant to filter sessions by

  • createdAtGestring

    Items where createdAt is greater than or equal to value. Use ISO 8601 datetime format

  • createdAtGtstring

    Items where createdAt is greater than specified value. Use ISO 8601 datetime format

  • createdAtLestring

    Items where createdAt is less than or equal to value. Use ISO 8601 datetime format

  • createdAtLtstring

    Items where createdAt is less than specified value. Use ISO 8601 datetime format

  • updatedAtGestring

    Items where updatedAt is greater than or equal to value. Use ISO 8601 datetime format

  • updatedAtGtstring

    Items where updatedAt is greater than specified value. Use ISO 8601 datetime format

  • updatedAtLestring

    Items where updatedAt is less than or equal to value. Use ISO 8601 datetime format

  • updatedAtLtstring

    Items where updatedAt is less than specified value. Use ISO 8601 datetime format

  • assistantIdAnystring

    Filter by multiple assistant IDs. Provide as comma-separated values

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Structured OutputsVAPI_STRUCTURED_OUTPUT_CONTROLLER_FIND_ALLAcción

Tool to list structured outputs with optional filtering and pagination. Use when you need to retrieve structured output configurations from Vapi.

Parámetros de entrada

  • idstring

    Filter results where the id matches the specified value.

  • namestring

    Filter results where the name matches the specified value.

  • pageinteger

    Page number to return. Defaults to 1.

  • limitinteger

    Maximum number of items to return. Defaults to 100.

  • sortOrderstringenum

    Sort order for pagination. Must be 'ASC' or 'DESC'. Defaults to 'DESC'.

    ASCDESC
  • createdAtGestring

    Return items where createdAt is greater than or equal to the specified value. Use ISO 8601 date-time format.

  • createdAtGtstring

    Return items where createdAt is greater than the specified value. Use ISO 8601 date-time format.

  • createdAtLestring

    Return items where createdAt is less than or equal to the specified value. Use ISO 8601 date-time format.

  • createdAtLtstring

    Return items where createdAt is less than the specified value. Use ISO 8601 date-time format.

  • updatedAtGestring

    Return items where updatedAt is greater than or equal to the specified value. Use ISO 8601 date-time format.

  • updatedAtGtstring

    Return items where updatedAt is greater than the specified value. Use ISO 8601 date-time format.

  • updatedAtLestring

    Return items where updatedAt is less than or equal to the specified value. Use ISO 8601 date-time format.

  • updatedAtLtstring

    Return items where updatedAt is less than the specified value. Use ISO 8601 date-time format.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ToolVAPI_TOOL_CONTROLLER_FIND_ONEAcción

Tool to fetch tool details by ID. Use when you have a tool ID and need full tool configuration including type, messages, function definitions, and server settings.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the tool to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Test Code Tool ExecutionVAPI_TOOL_CONTROLLER_TEST_CODE_EXECUTIONAcción

Tool to test TypeScript code execution in Vapi's code tool environment. Use when validating code before deploying it as a tool.

Parámetros de entrada

  • codestringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ToolVAPI_TOOL_CONTROLLER_UPDATEAcción

Tool 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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the tool to update

  • urlstring

    URL endpoint for apiRequest tools

  • typestring

    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

  • asyncboolean

    Whether the tool execution is asynchronous

  • methodstring

    HTTP method for apiRequest tools: GET, POST, PATCH, PUT, DELETE

  • serverobject

    Server configuration for tool requests including url, timeout, headers, and credentials

  • functionobject

    Function definition for function-type tools.

  • messagesobject[]

    Array of message objects for different tool states: ToolMessageStart, ToolMessageComplete, ToolMessageFailed, ToolMessageDelayed

  • backoffPlanobject

    Retry logic configuration with type, maxRetries, and baseDelaySeconds

  • destinationsobject[]

    Transfer destinations for transferCall tools

  • rejectionPlanobject

    Conditions determining when the tool should be rejected or not executed

  • variableExtractionPlanobject

    Schema and aliases for extracting variables from the call for use in the tool

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Phone NumberVAPI_UPDATE_PHONE_NUMBERAcción

Tool 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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the phone number to update. This is the phone number ID returned from VAPI.

  • namestring

    The name or label for the phone number to help identify it.

  • hooksobject[]

    List of webhook configurations to receive events for this phone number.

  • numberstring

    The actual phone number in E.164 format (e.g., +14155551234).

  • serverobject

    Server configuration for handling phone number events.

  • sip_uristring

    SIP URI for SIP-based phone numbers.

  • squad_idstring

    The ID of the squad to associate with this phone number. Alternative to assistant_id or workflow_id.

  • sms_enabledboolean

    Whether SMS is enabled for this phone number (Twilio provider only).

  • workflow_idstring

    The ID of the workflow to associate with this phone number. Alternative to assistant_id.

  • assistant_idstring

    The ID of the assistant to associate with this phone number. When calls are received, this assistant will handle them.

  • credential_idstring

    The ID of the credential to use for this phone number (provider-specific).

  • authenticationobject

    Authentication configuration for SIP-based phone numbers.

  • twilio_api_keystring

    Twilio API key (alternative to auth token).

  • twilio_api_secretstring

    Twilio API secret (used with API key).

  • twilio_auth_tokenstring

    Twilio authentication token (for Twilio provider).

  • twilio_account_sidstring

    Twilio account SID (required for Twilio provider).

  • fallback_destinationobject

    Fallback destination configuration when the primary assistant/workflow is unavailable.

  • number_e164_check_enabledboolean

    Whether to enable E.164 format validation for the phone number.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload FileVAPI_UPLOAD_FILEAcción

Tool 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.

Parámetros de entrada

  • fileobjectObligatorio

    File to upload to Vapi Knowledge Base. FileUploadable object where 'name' should be the filename for the uploaded file.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not