Vapi · Schema

ToolMessageDelayed

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
contents array This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. Usage: - If your assistants are multilingual, you can provide content for each la
type string This message is triggered when the tool call is delayed. There are the two things that can trigger this message: 1. The user talks with the assistant while your server is processing the request. Defau
timingMilliseconds number The number of milliseconds to wait for the server response before saying this message.
content string This is the content that the assistant says when this message is triggered.
conditions array This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.
View JSON Schema on GitHub

JSON Schema

vapi-toolmessagedelayed-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToolMessageDelayed",
  "title": "ToolMessageDelayed",
  "type": "object",
  "properties": {
    "contents": {
      "type": "array",
      "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextContent",
            "title": "Text"
          }
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.",
      "enum": [
        "request-response-delayed"
      ]
    },
    "timingMilliseconds": {
      "type": "number",
      "minimum": 100,
      "maximum": 120000,
      "example": 1000,
      "description": "The number of milliseconds to wait for the server response before saying this message."
    },
    "content": {
      "type": "string",
      "description": "This is the content that the assistant says when this message is triggered.",
      "maxLength": 1000
    },
    "conditions": {
      "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Condition"
      }
    }
  },
  "required": [
    "type"
  ]
}