Vapi · Schema

BotMessage

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
role string The role of the bot in the conversation.
message string The message content from the bot.
time number The timestamp when the message was sent.
endTime number The timestamp when the message ended.
secondsFromStart number The number of seconds from the start of the conversation.
source string The source of the message.
duration number The duration of the message in seconds.
View JSON Schema on GitHub

JSON Schema

vapi-botmessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BotMessage",
  "title": "BotMessage",
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "description": "The role of the bot in the conversation."
    },
    "message": {
      "type": "string",
      "description": "The message content from the bot."
    },
    "time": {
      "type": "number",
      "description": "The timestamp when the message was sent."
    },
    "endTime": {
      "type": "number",
      "description": "The timestamp when the message ended."
    },
    "secondsFromStart": {
      "type": "number",
      "description": "The number of seconds from the start of the conversation."
    },
    "source": {
      "type": "string",
      "description": "The source of the message."
    },
    "duration": {
      "type": "number",
      "description": "The duration of the message in seconds."
    }
  },
  "required": [
    "role",
    "message",
    "time",
    "endTime",
    "secondsFromStart"
  ]
}