Benchmarks

Get Benchmark models.

get
/api/v2/benchmarks/models

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.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Query parameters
benchmarkTypeIdinteger · int32Optional
Responses
chevron-right
200

OK

application/json
get
/api/v2/benchmarks/models

Get Benchmark model details.

get
/api/v2/benchmarks/models/{modelId}

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.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
modelIdinteger · int64Required
Query parameters
benchmarkTypeIdinteger · int32Optional
Responses
chevron-right
200

OK

application/json
get
/api/v2/benchmarks/models/{modelId}

Get Benchmark model probe runs.

get
/api/v2/benchmarks/models/{modelId}/runs

Get all probe runs for a specific benchmark model.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
modelIdinteger · int64Required
Query parameters
benchmarkTypeIdinteger · int32Required
Responses
chevron-right
200

OK

application/json
get
/api/v2/benchmarks/models/{modelId}/runs

Get details of a specific Benchmark probe run.

get
/api/v2/benchmarks/models/{modelId}/runs/{probeRunId}/test-cases

Retrieve detailed information about a specific Benchmark probe run by its unique identifier, including results, execution metadata and conversation.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Path parameters
modelIdinteger · int64Required
probeRunIdinteger · int64Required
Responses
chevron-right
200

OK

application/json
get
/api/v2/benchmarks/models/{modelId}/runs/{probeRunId}/test-cases

Get all Benchmark types.

get
/api/v2/benchmarks/types

Retrieve all available Benchmark types.

Authorizations
X-Api-KeystringRequired

API Key for authentication

Responses
chevron-right
200

OK

application/json
get
/api/v2/benchmarks/types

Last updated

Was this helpful?