v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01979563.0 MB

Eval

Get Eval Run

get/eval/run/{id}

Path parameters

idstring uuid required

The unique identifier for the resource.

Response

status'running' | 'ended' | 'queued' required

This is the status of the eval run. When an eval run is created, the status is 'running'. When the eval run is completed, the status is 'ended'.

endedReason'mockConversation.done' | 'error' | 'timeout' | 'cancelled' | 'aborted' required

This is the reason for the eval run to end. When the eval run is completed normally i.e end of mock conversation, the status is 'mockConversation.done'. When the eval fails due to an error like Chat error or incorrect configuration, the status is 'error'. When the eval runs for too long, due to model issues or tool call issues, the status is 'timeout'. When the eval run is cancelled by the user, the status is 'cancelled'. When the eval run is cancelled by Vapi for any reason, the status is 'aborted'.

idstring required

orgIdstring required

createdAtstring date-time required

startedAtstring date-time required

endedAtstring date-time required

endedMessagestring

This is the ended message when the eval run ended for any reason apart from mockConversation.done

costnumber required

This is the cost of the eval or suite run in USD.

costsobject[] required

This is the break up of costs of the eval or suite run.

type'eval' required

This is the type of the run. Currently it is fixed to eval.

evalIdstring

This is the id of the eval that will be run.