Skip to main content
POST
Create Eval

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id
integer
required

Tuner's internal numeric ID for the agent.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Input schema for creating/updating an eval.

name
string
required
Required string length: 1 - 200
scoring_type
string
required

PASS_FAIL for a yes/no check, SCORE_1_5 for a 1–5 rating. Simulations require at least one PASS_FAIL eval.

Pattern: ^(PASS_FAIL|SCORE_1_5)$
rule_logic
string
required

Instruction the AI applies to each call. For PASS_FAIL, phrase it so that passing is unambiguous.

Minimum string length: 1
order
integer | null
Required range: x >= 0
inputs_used
string[]

Response

Successful Response

Response schema for an eval.

id
integer
required

Unique identifier for the eval.

Example:

12

name
string
required

Name of the eval.

Example:

"Verified caller identity"

scoring_type
enum<string>
required

PASS_FAIL for a yes/no check, SCORE_1_5 for a 1–5 rating. Simulations require at least one PASS_FAIL eval.

Available options:
PASS_FAIL,
SCORE_1_5
Example:

"PASS_FAIL"

rule_logic
string
required

Instruction the AI applies to each call. For PASS_FAIL, phrasing is written so that passing is unambiguous.

Example:

"The agent confirmed the caller's name and date of birth."

is_system_added
boolean
required

Whether this eval was added automatically as a system default rather than created by a user.

Example:

false

is_removable
boolean
required

Whether this eval can be deleted. System defaults may be marked non-removable; attempting to delete a non-removable eval returns a 403.

Example:

true

order
integer
required

Display order relative to other evals for the agent.

Example:

0

inputs_used
string[]
required

The inputs the AI considers when evaluating this eval, e.g. "system_prompt", "tools", "allowed_capabilities", "workflow", or "metadata." for a specific metadata field.

Example: