For the complete documentation index, see llms.txt. This page is also available as Markdown.

Automate Load Tests

Kick off load tests from CI, the testvibe CLI, or an AI tool — the same load runs you dispatch from the app, driven over the API.

Everything you author in the Load section can be triggered from outside the app: list your load tests and dispatch a run over the REST API, the testvibe CLI, or the MCP server your AI tools connect to. You still configure load tests in the app (pick journeys or endpoints, users, duration, thresholds) — automation covers the two things you'd script: listing them and running them.

Authenticate with a tvb_… key from Settings → CLI & API keys. See CLI & API keys.

List your load tests

testvibe load list
curl -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/load"

Ask your assistant to use the list_load_tests tool.

Each load test shows its id, name, and status. Only tests with status generated are runnable.

Run a load test

# Dispatch and return immediately
testvibe load run "Checkout under load"

# Or wait for it to finish (handy as a CI gate)
testvibe load run "Checkout under load" --wait

Add --url https://staging.example.com to override the target for this run.

curl -X POST -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"siteUrl": "https://staging.example.com"}' \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/load/31/run"

Returns { "runId": …, "featureId": … }. Poll the run's status until it leaves running.

Ask your assistant to use run_load_test with the load test's name or id, then wait_for_run.

A dispatched load run is subject to your plan's load caps and credits — a rejected run comes back with a clear reason. The run shares the normal run spine, so you can read its status with the run tools (testvibe runs show <runId>, wait_for_run, get_run) and watch the live latency / throughput / error-rate charts in the app's Load section.

Automate on a recurring schedule

The CLI/REST/MCP path above is for you (or your CI pipeline) driving a load test on demand. To have TestVibe itself fire a load test on a cron schedule or whenever another run finishes, create an Automation with a Run a load test action instead — no external scheduler needed. Each firing dispatches exactly one run of the chosen load test.

Full reference

Request and response shapes, error codes, and AI-tool setup live in the developer handbook:

Last updated

Was this helpful?