← Tools Reference

Vapi

Vapi integration (AI, Communication). Imported from open-connector.

API key38 toolshttps://api.vapi.ai
GET
vapi_list_assistants
List Vapi assistants with optional created/updated timestamp filters and a configurable page size.

/assistant

9 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe maximum number of items to return.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
POST
vapi_create_assistant
Create a new Vapi assistant with required transcriber, voice, and model settings plus optional messaging and duration controls.

/assistant

10 parameters
ParamTypeRequiredDescription
namestringoptionalAssistant identifier or display name.
modelobjectrequiredA raw JSON object returned by Vapi.
voiceobjectrequiredA raw JSON object returned by Vapi.
transcriberobjectrequiredA raw JSON object returned by Vapi.
firstMessagestringoptionalThe first message the assistant should say.
systemPromptstringoptionalThe system prompt that controls assistant behavior.
clientMessagesarrayoptionalA list of string values.
serverMessagesarrayoptionalA list of string values.
maxDurationSecondsintegeroptionalThe maximum call duration in seconds.
voicemailDetectionobjectoptionalA raw JSON object returned by Vapi.
GET
vapi_get_assistant
Retrieve a Vapi assistant by its unique identifier.

/assistant/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
PATCH
vapi_update_assistant
Update an existing Vapi assistant and keep only the fields that should change in the request body.

/assistant/{id}

34 parameters
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
namestringoptionalThe updated assistant name.
modelobjectoptionalA raw JSON object returned by Vapi.
voiceobjectoptionalA raw JSON object returned by Vapi.
metadataobjectoptionalA raw JSON object returned by Vapi.
serverUrlstringoptionalThe server URL that should receive assistant events.
messagePlanobjectoptionalA raw JSON object returned by Vapi.
monitorPlanobjectoptionalA raw JSON object returned by Vapi.
transcriberobjectoptionalA raw JSON object returned by Vapi.
analysisPlanobjectoptionalA raw JSON object returned by Vapi.
artifactPlanobjectoptionalA raw JSON object returned by Vapi.
firstMessagestringoptionalThe first message that the assistant should say.
hipaaEnabledbooleanoptionalWhether HIPAA mode should be enabled.
credentialIdsarrayoptionalA list of string values.
clientMessagesarrayoptionalA list of string values.
maxDurationPlanobjectoptionalA raw JSON object returned by Vapi.
serverMessagesarrayoptionalA list of string values.
backgroundSoundstringoptionalThe background sound profile to use during calls.
endCallMessagestringoptionalThe message spoken before ending the call.
endCallPhrasesarrayoptionalA list of string values.
stopSpeakingPlanobjectoptionalA raw JSON object returned by Vapi.
serverUrlSecretstringoptionalThe secret used to authenticate requests to the server URL.
startSpeakingPlanobjectoptionalA raw JSON object returned by Vapi.
voicemailMessagestringoptionalThe message spoken when voicemail is detected.
firstMessageModestringoptionalWhether the assistant should speak first or wait for the user.
backchannelEnabledbooleanoptionalWhether verbal backchannel acknowledgments are enabled.
maxDurationSecondsintegeroptionalThe maximum call duration in seconds.
responseDelaySecondsnumberoptionalThe delay before the assistant responds.
silenceTimeoutSecondsintegeroptionalThe silence timeout, in seconds.
transportConfigurationsarrayoptionalA list of raw Vapi objects.
llmRequestDelaySecondsnumberoptionalThe delay before sending LLM requests.
backgroundDenoisingEnabledbooleanoptionalWhether background denoising is enabled.
modelOutputInMessagesEnabledbooleanoptionalWhether model output should be included in message payloads.
numWordsToInterruptAssistantintegeroptionalThe number of spoken words required to interrupt the assistant.
GET
vapi_list_calls
List Vapi calls with optional filtering by call, assistant, phone number, and created or updated timestamps.

/call

12 parameters
ParamTypeRequiredDescription
idstringoptionalFilter results by a specific call identifier.
limitintegeroptionalThe maximum number of items to return.
assistantIdstringoptionalFilter results by the assistant identifier.
phoneNumberIdstringoptionalFilter results by the phone number identifier.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
GET
vapi_get_call
Retrieve a single Vapi call by its unique identifier.

/call/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
DELETE
vapi_delete_call
Delete a Vapi call by its unique identifier.

/call/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
GET
vapi_list_chats
List Vapi chats with pagination plus optional assistant, squad, session, previous chat, and timestamp filters.

/chat

17 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
squadIdstringoptionalFilter results by the squad identifier.
sessionIdstringoptionalFilter results by the session identifier.
assistantIdstringoptionalFilter results by the assistant identifier.
assistantIdAnystringoptionalFilter results by multiple assistant identifiers separated by commas.
previousChatIdstringoptionalFilter results by the previous chat identifier.
GET
vapi_get_chat
Retrieve a Vapi chat by its unique identifier.

/chat/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
DELETE
vapi_delete_chat
Delete a Vapi chat by its unique identifier.

/chat/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
POST
vapi_create_openai_chat
Create an OpenAI-compatible Vapi chat response using an assistant or squad, with optional session and transport settings.

/chat/responses

11 parameters
ParamTypeRequiredDescription
namestringoptionalThe chat name for reference.
inputstringrequiredThe input text or messages for the chat.
squadobjectoptionalA raw JSON object returned by Vapi.
streambooleanoptionalWhether Vapi should stream the response. This connector only supports false.
squadIdstringoptionalThe identifier of an existing squad.
assistantobjectoptionalA raw JSON object returned by Vapi.
sessionIdstringoptionalThe identifier of an existing session.
transportobjectoptionalA raw JSON object returned by Vapi.
assistantIdstringoptionalThe identifier of an existing assistant.
previousChatIdstringoptionalThe previous chat identifier used as conversation context.
assistantOverridesobjectoptionalA raw JSON object returned by Vapi.
POST
vapi_create_analytics_query
Create and execute one or more Vapi analytics queries across call and subscription data.

/analytics

1 parameter
ParamTypeRequiredDescription
queriesarrayrequiredThe analytics queries to execute.
POST
vapi_create_eval
Create a Vapi eval for a mock conversation and define the checkpoint messages used to evaluate model behavior.

/eval

4 parameters
ParamTypeRequiredDescription
namestringoptionalThe eval name.
typestringoptionalThe eval type.
messagesarrayrequiredThe mock conversation and evaluation messages.
descriptionstringoptionalThe eval description.
GET
vapi_get_eval
Retrieve a Vapi eval by its unique identifier.

/eval/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
PATCH
vapi_update_eval
Update a Vapi eval and keep only the fields that should change in the request body.

/eval/{id}

5 parameters
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
namestringoptionalThe updated eval name.
typestringoptionalThe updated eval type.
messagesarrayoptionalA list of raw Vapi objects.
descriptionstringoptionalThe updated eval description.
DELETE
vapi_delete_eval
Delete a Vapi eval by its unique identifier.

/eval/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
DELETE
vapi_delete_eval_run
Delete a Vapi eval run by its unique identifier.

/eval/run/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
GET
vapi_list_evals
List Vapi evals with pagination plus optional identifier and timestamp-based filters.

/eval

12 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
GET
vapi_get_file
Retrieve Vapi file metadata by file identifier.

/file/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
POST
vapi_upload_file
Upload a file to Vapi knowledge storage from a public URL or base64 payload and return the resulting file metadata.

/file

1 parameter
ParamTypeRequiredDescription
fileobjectrequiredA file payload to upload to Vapi.
GET
vapi_list_monitoring_policies
List Vapi monitoring policies with optional severity, monitor, and timestamp filters.

/monitoring/policy

14 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
severitystringoptionalThe monitoring policy severity level.
monitorIdstringoptionalFilter results by monitor identifier.
POST
vapi_create_policy
Create a Vapi monitoring policy with severity, threshold, and schedule or interval configuration.

/monitoring/policy

7 parameters
ParamTypeRequiredDescription
namestringrequiredThe policy name.
intervalobjectoptionalA raw JSON object returned by Vapi.
scheduleobjectoptionalA raw JSON object returned by Vapi.
severitystringrequiredThe severity level of the policy.
thresholdobjectrequiredA raw JSON object returned by Vapi.
monitorIdsarrayoptionalA list of string values.
lookbackWindowMinutesintegerrequiredThe lookback window, in minutes.
GET
vapi_list_provider_resources
List Vapi provider resources for a provider and resource type with optional identifier and timestamp filters.

/provider/{provider}/{resourceName}

15 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
providerstringrequiredThe provider that owns the resource.
resourceNamestringrequiredThe provider resource type, such as pronunciation-dictionary.
resourceIdstringoptionalFilter results by the provider-side resource identifier.
POST
vapi_create_provider_resource
Create a pronunciation dictionary provider resource in Vapi, defaulting to the 11labs pronunciation-dictionary route used by the upstream toolkit.

/provider/{provider}/{resourceName}

4 parameters
ParamTypeRequiredDescription
providerstringrequiredThe provider that should own the resource. Defaults to 11labs.
resourceNamestringrequiredThe provider resource type. Defaults to pronunciation-dictionary.
namestringrequiredThe display name of the pronunciation dictionary.
rulesarrayrequiredThe pronunciation rules to create.
GET
vapi_list_phone_numbers
List Vapi phone numbers with optional created and updated timestamp filters.

/phone-number

9 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe maximum number of items to return.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
POST
vapi_create_phone_number
Create a Vapi phone number using Vapi, Twilio, Vonage, Telnyx, or bring-your-own provider settings.

/phone-number

15 parameters
ParamTypeRequiredDescription
namestringoptionalThe display name of the phone number.
numberstringoptionalThe E.164 phone number, when the provider requires one.
sipUristringoptionalThe SIP URI used by Vapi-managed SIP numbers.
providerstringrequiredThe phone number provider.
squadIdstringoptionalThe squad identifier attached to the phone number.
smsEnabledbooleanoptionalWhether SMS is enabled for the phone number.
workflowIdstringoptionalThe workflow identifier attached to the phone number.
assistantIdstringoptionalThe assistant identifier attached to the phone number.
credentialIdstringoptionalThe credential identifier used by the phone provider.
twilioApiKeystringoptionalThe Twilio API key.
twilioApiSecretstringoptionalThe Twilio API secret.
twilioAuthTokenstringoptionalThe Twilio auth token.
twilioAccountSidstringoptionalThe Twilio account SID.
numberDesiredAreaCodestringoptionalThe desired area code when Vapi provisions a number automatically.
numberE164CheckEnabledbooleanoptionalWhether E.164 validation should be enforced.
PATCH
vapi_update_phone_number
Update a Vapi phone number and keep only the fields that should change in the request body.

/phone-number/{id}

18 parameters
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
namestringoptionalThe updated display name of the phone number.
hooksarrayoptionalA list of raw Vapi objects.
numberstringoptionalThe updated E.164 phone number.
serverobjectoptionalA raw JSON object returned by Vapi.
sipUristringoptionalThe updated SIP URI.
squadIdstringoptionalThe updated squad identifier.
smsEnabledbooleanoptionalWhether SMS is enabled.
workflowIdstringoptionalThe updated workflow identifier.
assistantIdstringoptionalThe updated assistant identifier.
credentialIdstringoptionalThe updated credential identifier.
authenticationobjectoptionalA raw JSON object returned by Vapi.
twilioApiKeystringoptionalThe updated Twilio API key.
twilioApiSecretstringoptionalThe updated Twilio API secret.
twilioAuthTokenstringoptionalThe updated Twilio auth token.
twilioAccountSidstringoptionalThe updated Twilio account SID.
fallbackDestinationobjectoptionalA raw JSON object returned by Vapi.
numberE164CheckEnabledbooleanoptionalWhether E.164 validation is enabled.
DELETE
vapi_delete_phone_number
Delete a Vapi phone number by its unique identifier.

/phone-number/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
GET
vapi_list_structured_outputs
List Vapi structured outputs with pagination plus optional identifier, name, and timestamp filters.

/structured-output

13 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
namestringoptionalFilter results by a specific structured output name.
GET
vapi_list_insights
List Vapi insights with pagination plus optional identifier and timestamp filters.

/reporting/insight

12 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
PATCH
vapi_update_insight
Update a Vapi insight by replacing its name, queries, formulas, grouping, and time range settings.

/reporting/insight/{id}

9 parameters
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
namestringoptionalThe updated insight name.
typestringrequiredThe updated insight type.
formulaobjectoptionalA raw JSON object returned by Vapi.
groupBystringoptionalThe grouping field for the insight.
queriesarrayrequiredThe updated query definitions.
formulasarrayoptionalA list of raw Vapi objects.
metadataobjectoptionalA raw JSON object returned by Vapi.
timeRangestringoptionalThe updated time range for the insight.
POST
vapi_create_scorecard
Create a Vapi scorecard for observability and evaluation using structured output metrics and conditions.

/observability/scorecard

4 parameters
ParamTypeRequiredDescription
namestringoptionalThe scorecard name.
metricsarrayrequiredThe scorecard metrics.
descriptionstringoptionalThe scorecard description.
assistantIdsarrayoptionalA list of string values.
GET
vapi_list_scorecards
List Vapi scorecards with pagination plus optional identifier and timestamp filters.

/observability/scorecard

12 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
POST
vapi_create_session
Create a Vapi session with either an assistant identifier or an inline assistant configuration.

/session

3 parameters
ParamTypeRequiredDescription
namestringoptionalThe session name.
assistantobjectoptionalA raw JSON object returned by Vapi.
assistantIdstringoptionalThe identifier of an existing assistant.
GET
vapi_list_sessions
List Vapi sessions with pagination plus optional identifier, name, assistant, workflow, squad, and timestamp filters.

/session

17 parameters
ParamTypeRequiredDescription
idstringoptionalFilter by identifier.
pageintegeroptionalThe page number for pagination.
limitintegeroptionalThe maximum number of items to return.
sortOrderstringoptionalThe sort order for pagination.
createdAtGestringoptionalReturn items created on or after this ISO 8601 date-time string.
createdAtGtstringoptionalReturn items created after this ISO 8601 date-time string.
createdAtLestringoptionalReturn items created on or before this ISO 8601 date-time string.
createdAtLtstringoptionalReturn items created before this ISO 8601 date-time string.
updatedAtGestringoptionalReturn items updated on or after this ISO 8601 date-time string.
updatedAtGtstringoptionalReturn items updated after this ISO 8601 date-time string.
updatedAtLestringoptionalReturn items updated on or before this ISO 8601 date-time string.
updatedAtLtstringoptionalReturn items updated before this ISO 8601 date-time string.
namestringoptionalFilter results by a specific session name.
squadIdstringoptionalFilter results by the squad identifier.
workflowIdstringoptionalFilter results by the workflow identifier.
assistantIdstringoptionalFilter results by the assistant identifier.
assistantIdAnystringoptionalFilter results by multiple assistant identifiers separated by commas.
GET
vapi_get_tool
Retrieve a Vapi tool by its unique identifier.

/tool/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
PATCH
vapi_update_tool
Update a Vapi tool configuration, including function definitions, HTTP request settings, and retry policies.

/tool/{id}

12 parameters
ParamTypeRequiredDescription
idstringrequiredThe unique identifier of the target resource.
urlstringoptionalThe request URL for apiRequest tools.
typestringoptionalThe tool type.
asyncbooleanoptionalWhether the tool executes asynchronously.
methodstringoptionalThe HTTP method for apiRequest tools.
serverobjectoptionalA raw JSON object returned by Vapi.
functionobjectoptionalA raw JSON object returned by Vapi.
messagesarrayoptionalA list of raw Vapi objects.
backoffPlanobjectoptionalA raw JSON object returned by Vapi.
destinationsarrayoptionalA list of raw Vapi objects.
rejectionPlanobjectoptionalA raw JSON object returned by Vapi.
variableExtractionPlanobjectoptionalA raw JSON object returned by Vapi.
POST
vapi_test_code_tool_execution
Execute TypeScript code inside Vapi's code tool sandbox and return the logs, result, and execution outcome.

/tool/test

1 parameter
ParamTypeRequiredDescription
codestringrequiredThe TypeScript code that should be executed in Vapi's sandbox.