Eval

Create Eval

Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.

Authentication

AuthorizationBearer
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Request

This endpoint expects an object.
messageslist of objectsRequired
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 the flow where the model's response to previous conversation needs to be evaluated to check the content and tool calls
typeenumRequired

This is the type of the eval. Currently it is fixed to chat.mockConversation.

namestringOptional1-80 characters
This is the name of the eval. It helps identify what the eval is checking for.
descriptionstringOptional<=500 characters
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.

Response

messageslist of objects
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 the flow where the model's response to previous conversation needs to be evaluated to check the content and tool calls
idstring
The unique identifier for the eval.
orgIdstring
The unique identifier for the organization that owns the eval.
createdAtdatetime
The ISO 8601 timestamp when the eval was created.
updatedAtdatetime
The ISO 8601 timestamp when the eval was last updated.
typeenum

This is the type of the eval. Currently it is fixed to chat.mockConversation.

namestringOptional1-80 characters
This is the name of the eval. It helps identify what the eval is checking for.
descriptionstringOptional<=500 characters
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.