REST API
Automate TestVibe from your own tools — projects, features, runs, and load tests over a key-authenticated REST API.
Last updated
Was this helpful?
⌘Ctrlk
Automate TestVibe from your own tools — projects, features, runs, and load tests over a key-authenticated REST API.
Everything you can do in the app — list projects, manage features, dispatch and watch runs, read results, manage groups, drive generation, and more — is also available over the TestVibe REST API (the /api/v1/ops/* surface). The same API powers the testvibe CLI, the MCP server for AI tools, and the in-app Assistant's own tool calls, so all three stay in sync with what the API can do.
Every request carries a bearer key created in Settings → CLI & API keys:
Authorization: Bearer tvb_...A key is scoped to the account it was created in and inherits that account's project access. Revoke a key from the same panel if a machine is retired or a key may have leaked — see CLI & API keys.
Requests to the ops API (and therefore the CLI and MCP server, which are HTTP clients of it) are token-bucket limited:
Per account
5,000 requests/hour
Keyed on the account, not the individual key — creating more keys doesn't raise the ceiling.
Per IP
10,000 requests/hour
Applied before key validation, so an invalid-key flood can't be used to probe or overload the API.
Exceeding a limit returns 429 Too Many Requests with a Retry-After header. Self-hosted instances can disable rate limiting entirely via configuration if it isn't needed on a private network.
testvibe CLI And MCP ServerThe testvibe CLI and its MCP stdio server (for Claude Desktop/Code, Codex, and similar AI tools) wrap the same authenticated API — install once, then use the CLI directly or point an AI tool at the MCP server.
The testvibe package is not published to the public npm registry — running npm install -g testvibe will fail. Install it with the commands shown in Settings → CLI & API keys instead, which download and set up the CLI directly (no npm registry involved). Follow the exact command shown there for your OS.
Last updated
Was this helpful?
Was this helpful?