Skip to main content
GET
/
agent-eval
/
suites
/
{id}
Get suite
curl --request GET \
  --url https://api.goyappr.com/agent-eval/suites/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

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

Response

Suite

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