Vapi · Example Payload

Vapi Assistant Example

AIVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

Vapi Assistant Example is an example object payload from Vapi, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

transcribermodelvoicefirstMessagefirstMessageInterruptionsEnabledfirstMessageModevoicemailDetectionclientMessages

Example Payload

Raw ↑ 
{
  "transcriber": null,
  "model": null,
  "voice": null,
  "firstMessage": "Hello! How can I help you today?",
  "firstMessageInterruptionsEnabled": false,
  "firstMessageMode": "assistant-speaks-first",
  "voicemailDetection": null,
  "clientMessages": "conversation-update"
}