Vapi · Schema

ClientInboundMessageAddMessage

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string This is the type of the message. Send "add-message" message to add a message to the conversation history.
message object This is the message to add to the conversation.
triggerResponseEnabled boolean This is the flag to trigger a response, or to insert the message into the conversation history silently. Defaults to `true`. Usage: - Use `true` to trigger a response. - Use `false` to insert the mess
View JSON Schema on GitHub

JSON Schema

vapi-clientinboundmessageaddmessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientInboundMessageAddMessage",
  "title": "ClientInboundMessageAddMessage",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "This is the type of the message. Send \"add-message\" message to add a message to the conversation history.",
      "enum": [
        "add-message"
      ]
    },
    "message": {
      "description": "This is the message to add to the conversation.",
      "allOf": [
        {
          "$ref": "#/components/schemas/OpenAIMessage"
        }
      ]
    },
    "triggerResponseEnabled": {
      "type": "boolean",
      "description": "This is the flag to trigger a response, or to insert the message into the conversation history silently. Defaults to `true`.\n\nUsage:\n- Use `true` to trigger a response.\n- Use `false` to insert the message into the conversation history silently.\n\n@default true",
      "default": true
    }
  },
  "required": [
    "type",
    "message"
  ]
}