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": {}
}
'import requests
url = "https://api.goyappr.com/agent-eval/suites/{id}/run"
payload = { "agent_overrides": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_overrides: {}})
};
fetch('https://api.goyappr.com/agent-eval/suites/{id}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goyappr.com/agent-eval/suites/{id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent_overrides' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/agent-eval/suites/{id}/run"
payload := strings.NewReader("{\n \"agent_overrides\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.goyappr.com/agent-eval/suites/{id}/run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_overrides\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/agent-eval/suites/{id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_overrides\": {}\n}"
response = http.request(request)
puts response.read_body{
"suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}{
"error": "<string>",
"code": "<string>"
}Run a Suite
Enqueue every case under the suite as a fresh eval_runs row. Returns immediately
with a synthetic suite_run_id that groups the spawned runs. Workers pick up the
runs and process up to suite.parallelism at a time.
Required scope agent_eval:run. The runs are billed to the company’s credit balance
as they finish — see /billing/consumption?product=eval_run for an after-the-fact view.
Suites are always processed asynchronously — poll GET /agent-eval/suites/{id}/runs/{suite_run_id}
until in_flight === 0 to know the suite settled.
There is no synchronous balance check. If credit runs out, affected runs come back
with status: "failed" and the reason in each run’s error field — there is no 402.
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": {}
}
'import requests
url = "https://api.goyappr.com/agent-eval/suites/{id}/run"
payload = { "agent_overrides": {} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_overrides: {}})
};
fetch('https://api.goyappr.com/agent-eval/suites/{id}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.goyappr.com/agent-eval/suites/{id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent_overrides' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/agent-eval/suites/{id}/run"
payload := strings.NewReader("{\n \"agent_overrides\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.goyappr.com/agent-eval/suites/{id}/run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_overrides\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/agent-eval/suites/{id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_overrides\": {}\n}"
response = http.request(request)
puts response.read_body{
"suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}{
"error": "<string>",
"code": "<string>"
}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"
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
Passagent_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
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Path Parameters
Body
Optional overrides applied to every spawned run on top of each case's agent_overrides.