Vapi · Schema

ToolParameter

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
key string This is the key of the parameter.
value object The value of the parameter. Any JSON type. String values support Liquid templates.
View JSON Schema on GitHub

JSON Schema

vapi-toolparameter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ToolParameter",
  "title": "ToolParameter",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "This is the key of the parameter."
    },
    "value": {
      "description": "The value of the parameter. Any JSON type. String values support Liquid templates.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "object"
        },
        {
          "type": "array"
        }
      ]
    }
  },
  "required": [
    "key",
    "value"
  ]
}