Vapi · Schema

VariableExtractionAlias

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
key string This is the key of the variable. This variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call. Rules: - Must start with a letter (a-z, A-Z)
value string This is the value of the variable. This can reference existing variables, use filters, and perform transformations. Examples: "{{name}}", "{{customer.email}}", "Hello {{name | upcase}}"
View JSON Schema on GitHub

JSON Schema

vapi-variableextractionalias-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VariableExtractionAlias",
  "title": "VariableExtractionAlias",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "This is the key of the variable.\n\nThis variable will be accessible during the call as `{{key}}` and stored in `call.artifact.variableValues` after the call.\n\nRules:\n- Must start with a letter (a-z, A-Z).\n- Subsequent characters can be letters, numbers, or underscores.\n- Minimum length of 1 and maximum length of 40.",
      "minLength": 1,
      "maxLength": 40,
      "pattern": "/^[a-zA-Z][a-zA-Z0-9_]*$/"
    },
    "value": {
      "type": "string",
      "description": "This is the value of the variable.\n\nThis can reference existing variables, use filters, and perform transformations.\n\nExamples: \"{{name}}\", \"{{customer.email}}\", \"Hello {{name | upcase}}\"",
      "maxLength": 10000
    }
  },
  "required": [
    "key",
    "value"
  ]
}