Vapi · Schema

VoiceCost

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string This is the type of cost, always 'voice' for this class.
voice object This is the voice that was used during the call. This matches one of the following: - `call.assistant.voice`, - `call.assistantId->voice`, - `call.squad[n].assistant.voice`, - `call.squad[n].assistant
characters number This is the number of characters that were generated during the call. These should be total characters used in the call for single assistant calls, while squad calls will have multiple voice costs one
cost number This is the cost of the component in USD.
View JSON Schema on GitHub

JSON Schema

vapi-voicecost-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoiceCost",
  "title": "VoiceCost",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "This is the type of cost, always 'voice' for this class.",
      "enum": [
        "voice"
      ]
    },
    "voice": {
      "type": "object",
      "description": "This is the voice that was used during the call.\n\nThis matches one of the following:\n- `call.assistant.voice`,\n- `call.assistantId->voice`,\n- `call.squad[n].assistant.voice`,\n- `call.squad[n].assistantId->voice`,\n- `call.squadId->[n].assistant.voice`,\n- `call.squadId->[n].assistantId->voice`."
    },
    "characters": {
      "type": "number",
      "description": "This is the number of characters that were generated during the call. These should be total characters used in the call for single assistant calls, while squad calls will have multiple voice costs one for each assistant that was used."
    },
    "cost": {
      "type": "number",
      "description": "This is the cost of the component in USD."
    }
  },
  "required": [
    "type",
    "voice",
    "characters",
    "cost"
  ]
}