Skip to main content
Manage benchmark runs that execute all tasks in a benchmark and collect results.

Actions

ActionDescription
listList all benchmark runs in the organization
createStart a new benchmark run
getGet a benchmark run by ID
completeMark a benchmark run as complete
cancelCancel a benchmark run

Parameters

list

No parameters.

create

ParameterTypeRequiredDescription
benchmarkIdstringyesBenchmark ID to run

get

ParameterTypeRequiredDescription
idstringyesBenchmark run ID

complete

ParameterTypeRequiredDescription
idstringyesBenchmark run ID

cancel

ParameterTypeRequiredDescription
idstringyesBenchmark run ID

Examples

Start a benchmark run

{
  "action": "create",
  "benchmarkId": "bm_abc123"
}

Get run results

{
  "action": "get",
  "id": "br_xyz789"
}

Cancel a running benchmark

{
  "action": "cancel",
  "id": "br_xyz789"
}