Skip to main content
POST
Create an eval suite

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

Body

application/json
name
string
required

Unique within the project.

Required string length: 1 - 256
scenarios
object[]
required
Required array length: 1 - 20 elements

Either a reference to an existing scenario or a new scenario.

description
string | null
common_test_cases
object[]
Maximum array length: 50

Either a reference to an existing test case or a new test case.

sheet_refs
object

Sheet replacements for eval calls; see EvalSuite.sheet_refs.

field_overrides
object

Prompt field values for every call of the suite. Checked against the agent's overridable fields when a submission is created.

Response

The created suite

suite
object
required

A named, reusable set of scenarios plus test cases that apply to every scenario. An eval submission runs one suite against one agent.