Skip to main content
POST
/
agent-eval
/
suites
Create suite
curl --request POST \
  --url https://api.goyappr.com/agent-eval/suites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parallelism": 1
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "parallelism": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

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.

Suites are containers — create the suite first, then add cases by setting their suite_id. A suite with no cases can be created but POST /agent-eval/suites/{id}/run returns 400 until at least one case is attached.

​
Parallelism

parallelism (1-16) is the max number of cases that run concurrently when you trigger the suite. Higher = faster sweeps; lower = nicer to your credit balance if you’re worried about a pricing surprise. For a regression suite of ~20 cases, parallelism: 4 is a good starting point — finishes in roughly the time of the slowest 5 cases.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
​
description
string
​
agent_id
string<uuid> | null
​
parallelism
integer
default:1
Required range: 1 <= x <= 16

Response

Suite created

Curated bundle of eval cases that run as one batch (regression sweep).

​
id
string<uuid>
required
​
company_id
string<uuid>
required
​
name
string
required
​
parallelism
integer
default:1
required

Max concurrent cases when the suite runs.

Required range: 1 <= x <= 16
​
created_at
string<date-time>
required
​
description
string | null
​
agent_id
string<uuid> | null

Optional default agent for ad-hoc cases added to the suite. Per-case agent_id always wins; this is just a convenience for the dashboard.

​
updated_at
string<date-time>
​
deleted_at
string<date-time> | null