Update Assistant
Updates an existing assistant in Vapi.
Body
This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
This is the mode for the first message. Default is 'assistant-speaks-first'.
Use:
'assistant-speaks-first' to have the assistant speak first.
'assistant-waits-for-user' to have the assistant wait for the user to speak first.
'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (
assistant.model.messagesat call start,call.messagesat squad transfer points).
@default 'assistant-speaks-first'
These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema.
These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema.
This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. @default 600 (10 minutes)
This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. @default false
These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.
These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.
This is a set of actions that will be performed on certain events.
This is the name of the assistant. This is required when you want to transfer between assistants in a call.
This is the message that the assistant will say if the call is forwarded to voicemail. If unspecified, it will hang up.
This is the message that the assistant will say if it ends the call. If unspecified, it will hang up without saying anything.
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
This is for metadata you want to store on the assistant.
These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.
Comma-separated response fields to include.