Vapi · JSON Structure

Vapi Assistant Structure

Type: object Properties: 30

AIVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

Assistant is a JSON Structure definition published by Vapi, describing 30 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

transcriber model voice firstMessage firstMessageInterruptionsEnabled firstMessageMode voicemailDetection clientMessages serverMessages maxDurationSeconds backgroundSound modelOutputInMessagesEnabled transportConfigurations observabilityPlan credentials hooks name voicemailMessage endCallMessage endCallPhrases compliancePlan metadata backgroundSpeechDenoisingPlan analysisPlan artifactPlan startSpeakingPlan stopSpeakingPlan monitorPlan credentialIds server

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Assistant",
  "type": "object",
  "properties": {
    "transcriber": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "voice": {
      "type": "string"
    },
    "firstMessage": {
      "type": "string"
    },
    "firstMessageInterruptionsEnabled": {
      "type": "boolean"
    },
    "firstMessageMode": {
      "type": "string"
    },
    "voicemailDetection": {
      "type": "string"
    },
    "clientMessages": {
      "type": "array"
    },
    "serverMessages": {
      "type": "array"
    },
    "maxDurationSeconds": {
      "type": "number"
    },
    "backgroundSound": {
      "type": "string"
    },
    "modelOutputInMessagesEnabled": {
      "type": "boolean"
    },
    "transportConfigurations": {
      "type": "array"
    },
    "observabilityPlan": {
      "type": "string"
    },
    "credentials": {
      "type": "array"
    },
    "hooks": {
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "voicemailMessage": {
      "type": "string"
    },
    "endCallMessage": {
      "type": "string"
    },
    "endCallPhrases": {
      "type": "array"
    },
    "compliancePlan": {
      "type": "object"
    },
    "metadata": {
      "type": "object"
    },
    "backgroundSpeechDenoisingPlan": {
      "type": "string"
    },
    "analysisPlan": {
      "type": "string"
    },
    "artifactPlan": {
      "type": "string"
    },
    "startSpeakingPlan": {
      "type": "string"
    },
    "stopSpeakingPlan": {
      "type": "string"
    },
    "monitorPlan": {
      "type": "string"
    },
    "credentialIds": {
      "type": "array"
    },
    "server": {
      "type": "string"
    }
  }
}