Skip to main content
POST
/
create-evaluator
Create Evaluator
curl --request POST \
  --url https://api.heify.com/create-evaluator \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tag": "nombre de ejemplo",
  "description": "descripcion opcional",
  "language": "df",
  "context": "You are evaluating a salesperson during a sales call or meeting with a prospect or client. Assess their ability to identify needs, communicate value and handle objections.",
  "criteria": [
    {
      "name": "Cierre de Venta",
      "description": "El agente debe solicitar explicitamente la venta o el compromiso del cliente utilizando tecnicas de cierre directas como \"¿Procedemos con la contratacion?\" o \"¿Le gustaria activar el servicio hoy?\". No debe finalizar la llamada sin haber intentado cerrar al menos una vez.",
      "type": "boolean",
      "weight": 50
    },
    {
      "name": "Escucha Activa",
      "description": "El agente no interrumpe al cliente mientras expone su problema, confirma los datos clave repitiendo o parafraseando lo escuchado y realiza preguntas relevantes para entender la situacion completa antes de ofrecer una solucion.",
      "type": "strict",
      "weight": 0
    },
    {
      "name": "Empatia",
      "description": "El agente muestra comprension ante la situacion del cliente utilizando frases de reconocimiento como \"Entiendo su frustracion\", \"Lamento las molestias\" o \"Comprendo lo importante que es esto para usted\". No debe minimizar el problema ni usar un tono condescendiente.",
      "type": "scale",
      "weight": 50
    }
  ]
}
'
{
  "data": {
    "message": "Evaluator created successfully",
    "evaluator": {
      "evaluator_id": "47e865ea-67ee-4930-9064-0a07db10c6b3",
      "tag": "nombre de ejemplo",
      "description": "descripcion opcional",
      "language": "df",
      "context": "You are evaluating a salesperson during a sales call or meeting with a prospect or client. Assess their ability to identify needs, communicate value and handle objections.",
      "criteria": [
        {
          "id": "f5ccfa19-40d1-4d0c-aee5-4217a5a22485",
          "name": "Cierre de Venta",
          "description": "El agente debe solicitar explicitamente la venta...",
          "type": "boolean",
          "weight": 50
        },
        {
          "id": "beaac9a5-a067-4413-9721-874e3ccda50c",
          "name": "Escucha Activa",
          "description": "El agente no interrumpe al cliente...",
          "type": "strict",
          "weight": 0
        },
        {
          "id": "0daee516-3b0f-40b5-836e-f0850365d355",
          "name": "Empatia",
          "description": "El agente muestra comprension ante la situacion del cliente...",
          "type": "scale",
          "weight": 50
        }
      ],
      "created_at": "2026-03-21T14:19:57.834336+00:00"
    }
  }
}
The sum of all non-strict criterion weights must equal exactly 100. The weight of strict criteria is automatically set to 0 regardless of what you send.
The description of each criterion is the text the AI uses to evaluate the call. A clear, specific description directly improves evaluation accuracy. For guidance on writing effective criteria, see Evaluator — criteria.
language defaults to "df" (auto-detect from audio). See Evaluator — language for supported language codes.
Maximum 20 evaluators per account and 10 criteria per evaluator. See Rate Limits & Quotas.

Authorizations

x-api-key
string
header
required

Body

application/json
tag
string
required

Name/label for the evaluator. Max 100 characters.

criteria
object[]
required

List of evaluation criteria. Min 1, max 10 items. Non-strict weights must sum to exactly 100.

description
string | null

Description of the evaluator's purpose. Max 250 characters.

Maximum string length: 250
language
string
default:df

Language for AI evaluation output. "df" (default) auto-detects from audio. See Evaluator — language for supported codes.

context
string | null

Additional context provided to the AI during evaluation. Helps the model understand the business scenario. Max 1000 characters.

Maximum string length: 1000

Response

201 - application/json

Evaluator created successfully.

data
object