VAvapiai
Eval

Create Eval

Changed on
post/eval

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Request body

namestring

This is the name of the eval. It helps identify what the eval is checking for.

descriptionstring

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'chat.mockConversation' required

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

Example request

{
  "messages": [
    {
      "content": "The weather in San Francisco is sunny.",
      "toolCalls": [
        {
          "name": "get_weather"
        }
      ]
    }
  ],
  "name": "Verified User Flow Eval",
  "description": "This eval checks if the user flow is verified.",
  "type": "chat.mockConversation"
}

Response

idstring required
orgIdstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring

This is the name of the eval. It helps identify what the eval is checking for.

descriptionstring

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'chat.mockConversation' required

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

Example response

{
  "messages": [
    {
      "content": "The weather in San Francisco is sunny.",
      "toolCalls": [
        {
          "name": "get_weather"
        }
      ]
    }
  ],
  "name": "Verified User Flow Eval",
  "description": "This eval checks if the user flow is verified.",
  "type": "chat.mockConversation"
}

Changes

  • 766d1141206cRevision changes
    • info

      added the new optional request property //////////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

  • 796dc3003764Revision changes
    • warning

      added the new gemini-3.8-flash enum value to the ////////// response property for the response status

    • warning

      added the new gemini-3.8-flash enum value to the /////// response property for the response status

    • warning

      added the new gemini-3.8-flash enum value to the /////// response property for the response status

    This list may be incomplete.

Some revisions have not been checked yet.