Benchmarks
Get all Benchmark models. If benchmarkTypeId is provided, it will return the scores calculated for that specific benchmark type. If not provided, it will return the total score aggregated across all benchmark types.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/benchmarks/models HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"benchmarkDate": "2025-08-29T17:46:55.721Z",
"id": 1,
"name": "text",
"provider": "text",
"scores": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"url": "text"
}
]Get details of a specific Benchmark model. If benchmarkTypeId is provided, it will return the scores calculated for that specific benchmark type. If not provided, it will return the total score aggregated across all benchmark types.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/benchmarks/models/{modelId} HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"description": "text",
"failedCount": 1,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"passedCount": 1,
"ranks": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"totalCount": 1,
"benchmarkDate": "2025-08-29T17:46:55.721Z",
"id": 1,
"name": "text",
"provider": "text",
"scores": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"url": "text"
}Get all probe runs for a specific benchmark model.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/benchmarks/models/{modelId}/runs?benchmarkTypeId=1 HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"createdAt": "2025-08-29T17:46:55.721Z",
"failedCount": 1,
"id": 1,
"passedCount": 1,
"probeCategoryId": 1,
"probeCategoryName": "text",
"probeId": 1,
"probeName": "text",
"score": 1,
"totalCount": 1
}
]Retrieve detailed information about a specific Benchmark probe run by its unique identifier, including results, execution metadata and conversation.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/benchmarks/models/{modelId}/runs/{probeRunId}/test-cases HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"results": [
{
"attackId": "text",
"conversation": [
[
{
"messageContents": [
{
"audioUrl": "text",
"contentType": "text",
"documentUrl": "text",
"encodedAudioUrl": "text",
"encodedDocumentUrl": "text",
"encodedImageUrl": "text",
"encodedText": "text",
"imageUrl": "text",
"text": "text"
}
],
"role": "text"
}
]
],
"createdAt": "2025-08-29T17:46:55.721Z",
"explanation": "text",
"id": 1,
"redTeamer": "text",
"redTeamerLabels": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "text",
"strategy": "text",
"variation": "text"
}
],
"createdAt": "2025-08-29T17:46:55.721Z",
"failedCount": 1,
"id": 1,
"passedCount": 1,
"probeCategoryId": 1,
"probeCategoryName": "text",
"probeId": 1,
"probeName": "text",
"score": 1,
"totalCount": 1
}Retrieve all available Benchmark types.
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
GET /api/v2/benchmarks/types HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
[
{
"description": "text",
"id": 1,
"name": "text"
}
]Last updated