Vapi · Schema

ToolMessageFailed

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

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 fails. This message is never triggered for async tool calls. If this message is not provided, the model will be requested to respond. If this message is pr
endCallAfterSpokenEnabled boolean This is an optional boolean that if true, the call will end after the message is spoken. Default is false. @default false
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-toolmessagefailed-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToolMessageFailed",
  "title": "ToolMessageFailed",
  "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 fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.",
      "enum": [
        "request-failed"
      ]
    },
    "endCallAfterSpokenEnabled": {
      "type": "boolean",
      "description": "This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false",
      "example": false
    },
    "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"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vapi-toolmessagefailed"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.