Skip to main content
POST
Create evaluation criteria
Create a criteria mapped to an evaluation config. eval_id is required. Updating an existing one: see Update Evaluation Criteria.

Scoring fields

Each call gets a score from 0 to 100 for this criteria. The thresholds decide the result: With the UI defaults (pass_above 70, fail_below 40) a score of 85 passes, 55 is “Review” and 30 fails. review_below is the top of the Review band, so it should be pass_above - 1 (69 here). The UI sets it for you, and you can leave it out. Keep fail_below lower than pass_above.

Criteria

Pick criteria from this list (send the name exactly). If you do not send evaluation_prompt when creating, the default prompt below is used.

Headers

token
string
required

API token for authentication

Body

application/json
eval_id
integer
required

Evaluation ID

criteria
enum<string>

Criteria to score, picked from the list. When creating and evaluation_prompt is not sent, the default prompt of this criteria is used.

Available options:
Empathy,
Language Switch,
Turn Taking,
Context Awareness,
Recovery From Errors,
Intent Recognition,
Greeting Accuracy,
Intent Confirmation,
Probing Questions,
Call Closing,
No Offensive Content,
No Misrepresentation,
Privacy Compliance,
Confidence Level,
Input Metadata Consistency
evaluation_prompt
string

Prompt for this criteria. Optional when creating: the default prompt of the chosen criteria is used.

scoring_rubric
string

Optional free text that explains how to score this criteria (for example what a 90+ vs a 50 looks like). It is saved with the criteria. The in-app UI does not set it, so you can leave it out.

pass_above
integer

Score (0-100) at or above which the call passes this criteria (UI: "Pass ≥"). UI default 70.

Required range: 0 <= x <= 100
review_below
integer

Highest score (0-100) that still counts as "Review". The Review band is the scores between fail_below and pass_above. The UI sets it automatically to pass_above - 1, so you can usually leave it out. UI default 69.

Required range: 0 <= x <= 100
fail_below
integer

Score (0-100) below which the call fails this criteria (UI: "Fail <"). UI default 40.

Required range: 0 <= x <= 100
accuracy_percentage
integer

Weight of this criteria in the overall score (UI: "Weight"). Minimum 1; UI default 10. It is relative: with weights 10, 10 and 20 the criteria count for 25%, 25% and 50% of the overall score.

Required range: x >= 1

Response

200 - application/json

Success

The response is of type object.