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

Benchmark model information including identification, provider details, and performance scores.

or
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

Benchmark model information including identification, provider details, and performance scores.

idinteger · int32Required

Unique identifier for the Benchmark model.

namestring · nullableRequired

Name of the Benchmark model.

providerstring · nullableRequired

Provider or organization that created/maintains the model.

benchmarkDatestring · date-time · nullableOptional

Date when the Benchmark was executed or last updated.

urlstring · nullableOptional

Optional URL providing additional information or documentation about the model.

descriptionstring · nullableOptional

Optional description providing detailed information about the Benchmark model.

totalCountinteger · int32Required

Total number of test cases executed during the Benchmark run.

passedCountinteger · int32Required

Number of test cases that passed during the Benchmark execution.

failedCountinteger · int32Required

Number of test cases that failed during the Benchmark execution.

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

Benchmark probe run information including execution statistics, performance score, and probe identification.

or
or
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

Benchmark probe run information including execution statistics, performance score, and probe identification.

idinteger · int32Required

Unique identifier for the Benchmark probe run.

passedCountinteger · int32Required

Number of test cases that passed during the probe run.

failedCountinteger · int32Required

Number of test cases that failed during the probe run.

totalCountinteger · int32Required

Total number of test cases executed during the probe run.

scorenumber · floatRequired

Performance score calculated from the probe run results.

probeIdinteger · int32Required

Unique identifier of the probe that was executed.

probeNamestring · nullableRequired

Name of the probe that was executed.

probeCategoryIdinteger · int32Required

Unique identifier of the probe's category.

probeCategoryNamestring · nullableRequired

Name of the probe's category.

createdAtstring · date-timeRequired

Timestamp when the probe run was created and executed.

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

Benchmark type information containing identification and description.

idinteger · int32Required

Unique identifier for the Benchmark type.

namestring · nullableRequired

Name of the Benchmark type.

descriptionstring · nullableOptional

Additional context about the Benchmark type.

get
/api/v2/benchmarks/types

Last updated

Was this helpful?