Vapi · Schema

TavusVoice

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
cachingEnabled	boolean	This is the flag to toggle voice caching for the assistant.
provider	string	This is the voice provider that will be used.
voiceId	object	This is the provider-specific ID that will be used.
chunkPlan	object	This is the plan for chunking the model output before it is sent to the voice provider.
personaId	string	This is the unique identifier for the persona that the replica will use in the conversation.
callbackUrl	string	This is the url that will receive webhooks with updates regarding the conversation state.
conversationName	string	This is the name for the conversation.
conversationalContext	string	This is the context that will be appended to any context provided in the persona, if one is provided.
customGreeting	string	This is the custom greeting that the replica will give once a participant joines the conversation.
properties	object	These are optional properties used to customize the conversation.
fallbackPlan	object	This is the plan for voice provider fallbacks in the event that the primary voice provider fails.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TavusVoice",
  "title": "TavusVoice",
  "type": "object",
  "properties": {
    "cachingEnabled": {
      "type": "boolean",
      "description": "This is the flag to toggle voice caching for the assistant.",
      "example": true,
      "default": true
    },
    "provider": {
      "type": "string",
      "description": "This is the voice provider that will be used.",
      "enum": [
        "tavus"
      ]
    },
    "voiceId": {
      "description": "This is the provider-specific ID that will be used.",
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "r52da2535a"
          ],
          "title": "Preset Voice Options"
        },
        {
          "type": "string",
          "title": "Tavus Voice ID"
        }
      ]
    },
    "chunkPlan": {
      "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
      "allOf": [
        {
          "$ref": "#/components/schemas/ChunkPlan"
        }
      ]
    },
    "personaId": {
      "type": "string",
      "description": "This is the unique identifier for the persona that the replica will use in the conversation."
    },
    "callbackUrl": {
      "type": "string",
      "description": "This is the url that will receive webhooks with updates regarding the conversation state."
    },
    "conversationName": {
      "type": "string",
      "description": "This is the name for the conversation."
    },
    "conversationalContext": {
      "type": "string",
      "description": "This is the context that will be appended to any context provided in the persona, if one is provided."
    },
    "customGreeting": {
      "type": "string",
      "description": "This is the custom greeting that the replica will give once a participant joines the conversation."
    },
    "properties": {
      "description": "These are optional properties used to customize the conversation.",
      "allOf": [
        {
          "$ref": "#/components/schemas/TavusConversationProperties"
        }
      ]
    },
    "fallbackPlan": {
      "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
      "allOf": [
        {
          "$ref": "#/components/schemas/FallbackPlan"
        }
      ]
    }
  },
  "required": [
    "provider",
    "voiceId"
  ]
}