VapiAssistant

VapiAssistant type definition

Properties

id (string): Unique identifier for the assistant.
name (string): Name of the voice assistant.
business ([[Business]]): The business that owns this assistant.
description (string): Description of assistant purpose and capabilities.
status (string): Assistant status (active, inactive, training, archived).
firstMessage (string): Initial greeting message when call starts.
systemPrompt ([[VapiPrompt]]): System prompt defining assistant behavior and personality.
model ([[AssistantModel]]): LLM model configuration for the assistant.
voice ([[VapiVoice]]): Voice configuration for speech synthesis.
transcriber ([[VapiTranscriber]]): Transcription service configuration for speech-to-text.
tools ([[VapiTool]][]): Available tools and functions the assistant can execute.
knowledgeBase ([[VapiKnowledgeBase]]): Knowledge base for contextual information.
language (string): Primary language code (en, es, fr, de, etc.).
supportedLanguages (string[]): All supported language codes.
maxCallDuration (number): Maximum call duration in seconds.
silenceTimeout (number): Timeout for user silence in seconds before ending call.
interruptSensitivity (number): Sensitivity for interruptions (0-1, higher = more sensitive).
endCallOnSilence (boolean): Whether to end call after silence timeout.
endCallPhrases (string[]): Phrases that trigger call ending (goodbye, hang up, etc.).
forwardingNumber ([[VapiPhoneNumber]]): Phone number to forward calls to if needed.
voicemailDetection (boolean): Whether to detect voicemail and handle accordingly.
voicemailMessage (string): Message to leave if voicemail is detected.
recordCalls (boolean): Whether to record calls.
transcribeCalls (boolean): Whether to generate call transcripts.
analyticsSummary (boolean): Whether to generate analytics summaries.
hipaaCompliant (boolean): Whether assistant is HIPAA compliant.
privacyMode (boolean): Enhanced privacy mode for sensitive conversations.
backgroundSound (string): Background sound option (office, cafe, none).
backgroundSoundLevel (number): Background sound volume (0-1).
serverUrl ([[URL]]): Webhook URL for receiving call events.
serverSecret (string): Secret for validating webhook requests.
metadata (object): Custom key-value pairs for additional data.
totalCalls (number): Total number of calls handled by this assistant.
averageCallDuration (number): Average call duration in seconds.
successRate (number): Percentage of successful calls (0-100).
created (number): Timestamp when assistant was created (Unix timestamp).
updated (number): Timestamp of last update (Unix timestamp).