Skip to main content
POST
Run a suite
Enqueue every case under the suite as a fresh eval_runs row and return immediately. The response carries a suite_run_id you use to filter the runs back out:
Eval runs do not emit webhook events today — poll GET /agent-eval/runs?suite_run_id=... and wait for every entry to reach queue_status === "done" before treating the scoring fields as final. The single-case shortcut POST /agent-eval/cases/:id/run blocks up to 60s for synchronous results, but suite-run is always async.

Per-suite-run overrides

Pass agent_overrides in the request body to apply a config tweak to every spawned run on top of each case’s own agent_overrides. Useful for “run the whole suite with this draft system_prompt” without touching any case definitions.

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required

Body

application/json
agent_overrides
object | null

Optional overrides applied to every spawned run on top of each case's agent_overrides.

Response

Suite run queued

suite_run_id
string<uuid>
required
run_ids
string<uuid>[]
required