Parameter	Type	Required	Default	Description
`script_path`	t.Annotated[str, Field(description='Path to the test script.')]	yes	—	—
`vus`	t.Annotated[int \| `None`, Field(default=`None`, description='Override VU count.')]	no	—	—
`duration`	t.Annotated[str \| `None`, Field(default=`None`, description='Override duration (e.g. 30s, 1m).')]	no	—	—
`scenario`	t.Annotated[str \| `None`, Field(default=`None`, description='Run a specific scenario only.')]	no	—	—

`stop_run`¶

stop_run

Stop a running load test. Idempotent.

Returns:: dict[str, str]

Gracefully stop a running test. Idempotent — calling on a completed run returns already_completed.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—
`reason`	t.Annotated[str \| `None`, Field(default=`None`, description='Optional stop reason.')]	no	—	—

`pause_run`¶

pause_run

Pause a running load test.

Returns:: dict[str, str]

Pause a running test. Executors block before the next iteration.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—

`resume_run`¶

resume_run

Resume a paused load test.

Returns:: dict[str, str]

Resume a paused test.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—

`get_status`¶

get_status

Get current status of a test run.

Returns:: dict[str, t.Any]

Poll whether a run is still active or has completed.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—

`list_runs`¶

list_runs

List all active and completed test runs.

Returns:: list[dict[str, str]]

List all active and completed runs with their run_id, status, and script_path.

Discovery readonly¶

`discover_scenarios`¶

discover_scenarios

Load a script and return its scenarios without running.

Returns:: dict[str, t.Any]

Load a script and list its scenarios, thresholds, and lifecycle hooks without starting a run.

Parameters

Parameter	Type	Required	Default	Description
`script_path`	t.Annotated[str, Field(description='Path to the test script.')]	yes	—	—

`inspect_config`¶

inspect_config

Return the fully resolved configuration for a script.

Returns:: dict[str, t.Any]

Show the fully resolved test configuration for a script without starting a run.

Parameters

Parameter	Type	Required	Default	Description
`script_path`	t.Annotated[str, Field(description='Path to the test script.')]	yes	—	—

Metrics readonly¶

`get_metrics`¶

get_metrics

Get metrics for a test run. Optionally filter by metric name.

Returns:: dict[str, t.Any]

Retrieve the latest metric snapshot for a run. Without a metric_name filter, returns all metrics including timing percentiles, counters, and rates.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—
`metric_name`	t.Annotated[str \| `None`, Field(default=`None`, description='Filter to a specific metric.')]	no	—	—

Thresholds readonly¶

`get_thresholds`¶

get_thresholds

Get threshold evaluation results for a test run.

Returns:: dict[str, t.Any]

Evaluate threshold results for a completed run. Returns pass/fail status with actual vs expected values for each threshold expression.

Parameters

Parameter	Type	Required	Default	Description
`run_id`	t.Annotated[str, Field(description='The run identifier.')]	yes	—	—

Tools¶

Run Lifecycle mutating¶

start_run¶

stop_run¶

pause_run¶

resume_run¶

get_status¶

list_runs¶

Discovery readonly¶

discover_scenarios¶

inspect_config¶

Metrics readonly¶

get_metrics¶

Thresholds readonly¶

get_thresholds¶

`start_run`¶

`stop_run`¶

`pause_run`¶

`resume_run`¶

`get_status`¶

`list_runs`¶

`discover_scenarios`¶

`inspect_config`¶

`get_metrics`¶

`get_thresholds`¶