Fields
dropdown
default:"openai"
required
The provider of the assistant’s LLM. Options: openai, anthropic, google,
deep-seek, perplexity-ai, vapi, anyscale, together-ai, inflection-ai, groq,
xai, deepinfra
text
default:"gpt-4o-mini"
required
The model name (e.g., gpt-4o-mini, deepseek-chat, gemini-1.5-flash,
claude-3-haiku-20240307) must match the provider and allowed values in Vapi’s
API.
dropdown
default:"assistant"
required
The role of the assistant. Options: assistant, function, user, system, tool
text
The prompt for the assistant
text
The name of the assistant
number
default:"30"
How many seconds of silence to wait before ending the call. Must be between 10
and 3600 seconds
number
default:"600"
Maximum number of seconds that the call will last. Must be between 10 and
43200 seconds
boolean
default:"false"
Enable recording for the call
boolean
default:"false"
Determines whether the transcript is stored
text
default:"AI"
The name of the assistant in the transcript
text
default:"user"
The name of the user in the transcript
boolean
default:"false"
Enables filtering of noise and background speech while the user is talking
dropdown
default:"off"
Background sound in the call. Options: off, office
boolean
default:"false"
Settings to configure or disable voicemail detection
text
Message that the assistant will say if the call is forwarded to voicemail. If
unspecified, it will hang up
text
Message that the assistant will say if it ends the call (max 1000 characters).
If unspecified, it will hang up without saying anything
text
List of phrases that, if spoken by the assistant, will trigger the call to be
hung up. Case insensitive
dropdown
default:"assistant-speaks-first"
Options: assistant-speaks-first,
assistant-speaks-first-with-model-generated-message, assistant-waits-for-user
text
First message that the assistant will say. If unspecified, assistant will wait
for user to speak and use the model to respond
boolean
default:"false"
Enable the plan to customize the plan for the summary
text
The messages used to generate the summary
Return Values
text
Unique identifier for the assistant
text
Organization identifier
date
When the assistant was created
date
When the assistant was last updated
boolean
Whether an error occurred
text
Error message if an error occurred
number
Error status code if an error occurred
Need Help?
View our options for free community and priority support.
Have a feature request?
Post your feature request on ouridea board.