> For the complete documentation index, see [llms.txt](https://docs.testvibe.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.testvibe.com/testvibe-api/welcome/readme.md).

# Welcome

The **TestVibe API** lets you drive a TestVibe project from outside the app: manage features written in Gherkin, generate Playwright tests with AI, run them in isolated cloud sandboxes, and pull results and trace artifacts — all with a single API key.

One operations core powers three surfaces, so anything you can do with one of them you can do with all of them:

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>REST API</strong></td><td>A JSON API under <code>/api/v1/ops</code> for integrations and CI. Authenticate with a <code>tvb_…</code> API key.</td><td><a href="/pages/q7ELIyJJ54wLdfEnTVLL">/pages/q7ELIyJJ54wLdfEnTVLL</a></td></tr><tr><td><strong>testvibe CLI</strong></td><td>The npm package for your terminal: <code>testvibe run "Login" --wait</code> and friends.</td><td><a href="/pages/UdNA8mXbh6WsDlpZI721">/pages/UdNA8mXbh6WsDlpZI721</a></td></tr><tr><td><strong>MCP server</strong></td><td><code>testvibe mcp</code> exposes every operation as tools for Claude Code, Claude Desktop, Codex, and other MCP clients.</td><td><a href="/pages/LvT9yYWCgGxJoXstaTPr">/pages/LvT9yYWCgGxJoXstaTPr</a></td></tr></tbody></table>

## Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Quickstart</strong></td><td>Create a feature, generate its tests, and run them in a sandbox — in about five minutes.</td><td><a href="/pages/FHaRZML7KtPqizvk2EJr">/pages/FHaRZML7KtPqizvk2EJr</a></td></tr><tr><td><strong>Authentication</strong></td><td>Create an API key and connect securely.</td><td><a href="/pages/wQj4nhpcYrFRAfKDLNli">/pages/wQj4nhpcYrFRAfKDLNli</a></td></tr><tr><td><strong>Connect your AI tools</strong></td><td>Plug TestVibe into Claude Code, Claude Desktop, or Codex via MCP.</td><td><a href="/pages/matR4rM5J34VuGJSHVeO">/pages/matR4rM5J34VuGJSHVeO</a></td></tr></tbody></table>

{% hint style="info" %}
New to the data model? Start with [Core concepts](/testvibe-api/core-concepts/projects.md) — projects, the feature lifecycle, runs, and project files — before diving into the reference.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.testvibe.com/testvibe-api/welcome/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.