Skip to main content
POST
Create an eval scenario

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Body

application/json

Request body for create and replace. id, slug, active and position are ignored if sent.

name
string
erforderlich

Scenario name. slug is generated from it (lowercase letters, digits and underscores).

cases
object[]
erforderlich

Test cases of the scenario.

Minimum array length: 1
agent_id
integer
erforderlich

The voice agent to evaluate (its id from GET /api/v1/voice_agents).

number_id
integer
veraltet

Deprecated alias of agent_id.

description
string

Free-text description.

meta
object

Models and overrides used when running the scenario.

Antwort

The created scenario.

Full scenario as returned by get, create, replace and duplicate.

id
integer
erforderlich

ID of the scenario.

name
string
erforderlich

Scenario name.

slug
string
erforderlich

URL-safe identifier generated from name.

active
boolean
erforderlich

Whether the scenario is active in the dashboard.

cases
object[]
erforderlich

Test cases in order.

recent_runs
object[]
erforderlich

A page of recent runs, newest first.

runs_pagination
object
erforderlich

Paging information for recent_runs.

agent_id
integer
erforderlich

The voice agent the scenario tests.

description
string | null

Free-text description.

number_id
integer
veraltet

Deprecated alias of agent_id.

number_name
string | null
veraltet

Deprecated alias of agent_name.

meta
Eval Scenario Meta · object | null

Models and overrides used when running the scenario.

latest_run
Eval Run Summary · object | null

Summary of the most recent run.

agent_name
string | null

Name of that voice agent.