Benchmarks
GET
/v1/orgs/{org_id}/benchmarks/{run_id}Get Benchmark
Get a single benchmark run with results summary.
Runtime, CI or Admin tokenscope: readoperation_id: benchmarks.get
Authentication
Any bearer token belonging to the org can read this endpoint.
SDK install
pip install znyx-sdknpm install @znyx/sdkHeader parameters
| Name | Type | Required | Description |
|---|---|---|---|
| X-API-Key#header | string | null | optional | — |
| authorization#header | string | null | optional | — |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Response schema
idrequiredstring
dataset_idrequiredstring
policy_versionstring | null
bundle_idstring | null
statusrequiredstring
total_samplesinteger
completed_samplesinteger
results_summaryobject | null
started_atstring | null
completed_atstring | null
created_atstring | null
Errors & what triggers them
| Code | Trigger | Fix |
|---|---|---|
| 401 | Missing or expired Authorization header. | — |
| 403 | Token does not have org access (wrong org_id, or insufficient role). | — |
| 404 | Resource does not exist in this org. | — |
Request
curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/benchmarks/00000000-0000-0000-0000-000000000000' \ -H 'Authorization: Bearer $ZNYX_TOKEN'
Response
application/json
Successful Response
{
"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