Get Eval | Vapi

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

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

orgIdstring

createdAtdatetime

updatedAtdatetime

typeenum

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

Allowed values:

namestring1-80 characters

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

descriptionstring<=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.

Retrieve your API Key from Dashboard.

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

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

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.

1	{
2	"messages": [
3	{
4	"role": "assistant",
5	"content": "Welcome to the verified user flow. How can I assist you today?",
6	"toolCalls": [
7	{
8	"name": "verify_user_status",
9	"arguments": {
10	"userId": "12345"
11	}
12	}
13	]
14	}
15	],
16	"id": "a3f1c9e2-7b4d-4f8a-9c3e-2d5f6b7a8c9d",
17	"orgId": "org_987654321",
18	"createdAt": "2024-01-15T09:30:00Z",
19	"updatedAt": "2024-01-15T09:30:00Z",
20	"type": "chat.mockConversation",
21	"name": "Verified User Flow Eval",
22	"description": "This eval checks if the user flow is verified."
23	}

1	{
2	"messages": [
3	{
4	"role": "assistant",
5	"content": "Welcome to the verified user flow. How can I assist you today?",
6	"toolCalls": [
7	{
8	"name": "verify_user_status",
9	"arguments": {
10	"userId": "12345"
11	}
12	}
13	]
14	}
15	],
16	"id": "a3f1c9e2-7b4d-4f8a-9c3e-2d5f6b7a8c9d",
17	"orgId": "org_987654321",
18	"createdAt": "2024-01-15T09:30:00Z",
19	"updatedAt": "2024-01-15T09:30:00Z",
20	"type": "chat.mockConversation",
21	"name": "Verified User Flow Eval",
22	"description": "This eval checks if the user flow is verified."
23	}

$	curl https://api.vapi.ai/eval/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"