Skip to main content
POST
Create an eval run

Authorizations

Authorization
string
header
required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Path Parameters

projectId
string
required

Project id

agentId
string
required

Agent id

Body

application/json

A run of one eval suite against this agent, graded by one judge. By default the run tests the agent's current published version; set use_draft to test the draft, or agent_version_id to test a specific version. use_draft and agent_version_id cannot be combined.

name
string
required

Unique per agent. Adding a date or time is the usual way to name repeated runs.

Required string length: 1 - 256
suite_id
string
required

The eval suite to run

Minimum string length: 1
judge_id
string
required

The judge that grades each call

Minimum string length: 1
description
string
runs_per_scenario
integer
default:1

How many calls to place for each scenario.

Required range: 1 <= x <= 10
judge_concurrency
integer
default:5

How many calls are graded at once.

Required range: 1 <= x <= 50
judge_max_retries
integer
default:3

Retries when a grading request fails.

Required range: 0 <= x <= 10
max_parallel_calls
integer
default:2

Most calls this run has in progress at once. A platform-wide limit also applies.

Required range: 1 <= x <= 10
extra_common_test_case_ids
string[]

Test cases to check on every call of this run, in addition to the suite's own.

Maximum array length: 50
Minimum string length: 1
exclude_common_test_case_ids
string[]

Suite-wide test cases to leave out of this run.

Maximum array length: 50
Minimum string length: 1
use_isolated_data
boolean
default:false

Give each call its own temporary copy of the Google Sheets the agent's tools use, so calls cannot change the real sheets or each other's data. Has no effect when no tool declares a sheet.

simulator_audio_stack
enum<string>

Speech recognition and synthesis used by the simulated caller. Omitted: the default for your deployment. A value your deployment cannot provide is refused with 422.

Available options:
hamsa,
humain,
hamsa_selfhosted
simulator_llm
enum<string>

Language model behind the simulated caller. Omitted: the default for your deployment. A value your deployment cannot provide is refused with 422.

Available options:
selfhosted,
gemini
simulator_silence_mode
enum<string>

Whether the simulated caller may stay silent to wait for the agent: off (default) never, always whenever waiting is the right next step, flexible when a reasonable person would.

Available options:
off,
always,
flexible
simulator_model_config
object

Optional models for the simulated caller, one slot each for speech recognition, language model and speech synthesis. Each slot you include must name both a provider and a model; a slot you leave out keeps the default for the run. Choose values from the simulated-caller options of GET /v1/agents/chained-options.

use_draft
boolean
default:false

Test the agent's current draft instead of its published version.

agent_version_id
string

Test this specific version of the agent (any status).

Minimum string length: 1

Response

The run was created, paused

submission
object
required

An eval run: one suite run against one agent version and graded by one judge, with the suite, judge, scenarios and test cases it uses and its progress so far.