Skip to main content

Benchmarks

GET/v1/orgs/{org_id}/benchmarks/compare

Compare Benchmarks

Compare two benchmark runs side by side.

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

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
a#querystringrequiredRun A ID
b#querystringrequiredRun B ID

Header parameters

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

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

any

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/compare' \
  -H 'Authorization: Bearer $ZNYX_TOKEN'

Response

application/json

Successful Response

null

Schema: any