Skip to main content
GET
/
v1
/
knowledge-base
/
evals
/
runs
/
{run_id}
Get an evaluation run
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/evals/runs/{run_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suite_name_snapshot": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "total_cases": 123,
  "completed_cases": 123,
  "passed_cases": 123,
  "failed_cases": 123,
  "errored_cases": 123,
  "average_score": 123,
  "error_message": "<string>",
  "kb_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "prefer_draft": true,
  "version_overrides": {},
  "generator_model_override": "<string>",
  "judge_model_override": "<string>",
  "pass_threshold_snapshot": 123,
  "retrieval_top_k_snapshot": 123,
  "total_input_tokens": 123,
  "total_output_tokens": 123,
  "total_cost_usd": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

run_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
suite_id
string<uuid> | null
required
suite_name_snapshot
string
required
organization_id
string<uuid>
required
created_by_user_id
string<uuid> | null
required
status
string
required
total_cases
integer
required
completed_cases
integer
required
passed_cases
integer
required
failed_cases
integer
required
errored_cases
integer
required
average_score
number | null
required
error_message
string | null
required
kb_ids
string<uuid>[]
required
prefer_draft
boolean
required
version_overrides
Version Overrides · object
required
generator_model_override
string | null
required
judge_model_override
string | null
required
pass_threshold_snapshot
integer
required
retrieval_top_k_snapshot
integer
required
total_input_tokens
integer
required
total_output_tokens
integer
required
total_cost_usd
number
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required