Skip to main content
POST
/
agent-eval
/
suites
/
{id}
/
run
Run a suite
curl --request POST \
  --url https://api.goyappr.com/agent-eval/suites/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_overrides": {}
}
'
{
  "suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

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: 
curl "https://api.goyappr.com/agent-eval/runs?suite_run_id=$SUITE_RUN_ID" \
  -H "Authorization: Bearer $YAPPR_API_KEY"
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

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