Skip to main content
POST
Run a benchmark

Authorizations

Authorization
string
header
required

An API key minted in Command Center (Settings -> API Keys), sent as Authorization: Bearer 2501_ak_.... A Command Center session cookie is also accepted.

Body

application/json
org_id
string
required
scenario_ids
string[]
required
Required array length: 1 - 50 elements
with_agent
boolean
default:true
gateway
enum<string>
default:runner
Available options:
runner,
servicenow
main_engine
string
Minimum string length: 1
secondary_engine
string
Minimum string length: 1
gateway_engine
string
Minimum string length: 1
sequential
boolean
default:false

Response

The launched benchmark

benchmark_id
string
required
Example:

"bch_0f4a6d1b-..."

workflow_id
string
required
Example:

"wfl_7d3b9c2e-..."

report_ids
string[]
required

One report per scenario, in the order they were given