Skip to main content

Benchmarks

GET/v1/orgs/{org_id}/benchmarks

List Benchmarks

List benchmark runs for an organization.

Runtime, CI or Admin tokenscope: readoperation_id: benchmarks.list

Authentication

Any bearer token belonging to the org can read this endpoint.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Query parameters

NameTypeRequiredDescription
dataset_id#querystring | nulloptional
status#querystring | nulloptional
limit#queryintegeroptional
offset#queryintegeroptional

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

totalrequiredinteger
limitrequiredinteger
offsetrequiredinteger
runsrequired

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have org access (wrong org_id, or insufficient role).
404Resource does not exist in this org.

Request

curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/benchmarks' \
  -H 'Authorization: Bearer $ZNYX_TOKEN'

Response

application/json

Successful Response

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "runs": [
    {
      "id": "string",
      "dataset_id": "string",
      "policy_version": null,
      "bundle_id": null,
      "status": "string",
      "total_samples": 0,
      "completed_samples": 0,
      "results_summary": null,
      "started_at": null,
      "completed_at": null,
      "created_at": null
    }
  ]
}

Schema: object