Vapi · Schema

FallbackAzureVoice

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.
speed number This is the speed multiplier that will be used.
chunkPlan object This is the plan for chunking the model output before it is sent to the voice provider.
View JSON Schema on GitHub

JSON Schema

vapi-fallbackazurevoice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FallbackAzureVoice",
  "title": "FallbackAzureVoice",
  "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": [
        "azure"
      ]
    },
    "voiceId": {
      "description": "This is the provider-specific ID that will be used.",
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "andrew",
            "brian",
            "emma"
          ],
          "title": "Preset Voice Options"
        },
        {
          "type": "string",
          "title": "Azure Voice ID"
        }
      ]
    },
    "speed": {
      "type": "number",
      "description": "This is the speed multiplier that will be used.",
      "minimum": 0.5,
      "maximum": 2
    },
    "chunkPlan": {
      "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
      "allOf": [
        {
          "$ref": "#/components/schemas/ChunkPlan"
        }
      ]
    }
  },
  "required": [
    "provider",
    "voiceId"
  ]
}