Vapi · Schema

EvaluationPlanItem

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
structuredOutputId string This is the ID of an existing structured output to use for evaluation. Mutually exclusive with structuredOutput.
structuredOutput object This is an inline structured output definition for evaluation. Mutually exclusive with structuredOutputId. Only primitive schema types (string, number, integer, boolean) are allowed.
comparator string This is the comparison operator to use when evaluating the extracted value against the expected value. Available operators depend on the structured output's schema type: - boolean: '=', '!=' - string:
value object This is the expected value to compare against the extracted structured output result. Type should match the structured output's schema type.
required boolean This is whether this evaluation must pass for the simulation to pass. Defaults to true. If false, the result is informational only.
View JSON Schema on GitHub

JSON Schema

vapi-evaluationplanitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EvaluationPlanItem",
  "title": "EvaluationPlanItem",
  "type": "object",
  "properties": {
    "structuredOutputId": {
      "type": "string",
      "description": "This is the ID of an existing structured output to use for evaluation.\nMutually exclusive with structuredOutput.",
      "format": "uuid"
    },
    "structuredOutput": {
      "description": "This is an inline structured output definition for evaluation.\nMutually exclusive with structuredOutputId.\nOnly primitive schema types (string, number, integer, boolean) are allowed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateStructuredOutputDTO"
        }
      ]
    },
    "comparator": {
      "type": "string",
      "description": "This is the comparison operator to use when evaluating the extracted value against the expected value.\nAvailable operators depend on the structured output's schema type:\n- boolean: '=', '!='\n- string: '=', '!='\n- number/integer: '=', '!=', '>', '<', '>=', '<='",
      "enum": [
        "=",
        "!=",
        ">",
        "<",
        ">=",
        "<="
      ],
      "example": "="
    },
    "value": {
      "description": "This is the expected value to compare against the extracted structured output result.\nType should match the structured output's schema type.",
      "oneOf": [
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "required": {
      "type": "boolean",
      "description": "This is whether this evaluation must pass for the simulation to pass.\nDefaults to true. If false, the result is informational only.",
      "default": true
    }
  },
  "required": [
    "comparator",
    "value"
  ]
}

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-evaluationplanitem"
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.