Skip to main content
GET
/
v1
/
knowledge-base
/
evals
/
suites
/
{suite_id}
Get an evaluation suite with its cases
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/evals/suites/{suite_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "pass_threshold": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "question": "<string>",
      "expected_answer": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "success_criteria": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
suite_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
pass_threshold
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
cases
KBEvalCaseResponse · object[]