Vapi · Schema

Vapi Eval

JSON Schema for the Vapi Eval resource as returned by the Vapi API.

AIVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

Properties

Name	Type	Description
messages	array	This is the mock conversation that will be used to evaluate the flow of the conversation. Mock Messages are used to simulate the flow of the conversation Evaluation Messages are used as checkpoints in
id	string
orgId	string
createdAt	string
updatedAt	string
name	string	This is the name of the eval. It helps identify what the eval is checking for.
description	string	This is the description of the eval. This helps describe the eval and its purpose in detail. It will not be used to evaluate the flow of the conversation.
type	string	This is the type of the eval. Currently it is fixed to `chat.mockConversation`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.com/schemas/vapi/vapi-eval-schema.json",
  "title": "Vapi Eval",
  "description": "JSON Schema for the Vapi Eval resource as returned by the Vapi API.",
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "description": "This is the mock conversation that will be used to evaluate the flow of the conversation.\n\nMock Messages are used to simulate the flow of the conversation\n\nEvaluation Messages are used as checkpoints in the flow where the model's response to previous conversation needs to be evaluated to check the c",
      "items": {}
    },
    "id": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string",
      "description": "This is the name of the eval.\nIt helps identify what the eval is checking for."
    },
    "description": {
      "type": "string",
      "description": "This is the description of the eval.\nThis helps describe the eval and its purpose in detail. It will not be used to evaluate the flow of the conversation."
    },
    "type": {
      "type": "string",
      "description": "This is the type of the eval.\nCurrently it is fixed to `chat.mockConversation`.",
      "enum": [
        "chat.mockConversation"
      ]
    }
  },
  "required": [
    "messages",
    "id",
    "orgId",
    "createdAt",
    "updatedAt",
    "type"
  ]
}