> 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/api-reference/reference.md).

# Overview

The API is **resource-oriented JSON over HTTPS**, mounted under:

```
https://YOUR-TESTVIBE-SERVER/api/v1/ops
```

Each reference page documents one operation across its three surfaces: the **REST route**, the **MCP tool** (same name as the page), and the **CLI command**. They are generated from one shared manifest and one shared operations core, so behavior and guardrails are identical everywhere.

## Operations at a glance

| MCP tool                                                                                   | REST                                                            | CLI                                             |
| ------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------- |
| [`list_projects`](/testvibe-api/api-reference/projects/list_projects.md)                   | `GET /projects`                                                 | `testvibe projects`                             |
| [`list_features`](/testvibe-api/api-reference/features/list_features.md)                   | `GET /projects/{project}/features`                              | `testvibe features list`                        |
| [`get_feature`](/testvibe-api/api-reference/features/get_feature.md)                       | `GET /projects/{project}/features/{feature}`                    | `testvibe features show <feature>`              |
| [`create_feature`](/testvibe-api/api-reference/features/create_feature.md)                 | `POST /projects/{project}/features`                             | `testvibe features create <name> --file <path>` |
| [`update_feature`](/testvibe-api/api-reference/features/update_feature.md)                 | `PATCH /projects/{project}/features/{feature}`                  | `testvibe features update <feature> …`          |
| [`delete_feature`](/testvibe-api/api-reference/features/delete_feature.md)                 | `DELETE /projects/{project}/features/{feature}`                 | `testvibe features delete <feature>`            |
| [`generate_feature`](/testvibe-api/api-reference/generation/generate_feature.md)           | `POST /projects/{project}/features/{feature}/generate`          | `testvibe generate <feature>`                   |
| [`get_generation_status`](/testvibe-api/api-reference/generation/get_generation_status.md) | `GET /projects/{project}/features/{feature}/generation`         | `testvibe generate <feature> --watch`           |
| [`wait_for_generation`](/testvibe-api/api-reference/generation/wait_for_generation.md)     | *(poll the status route)*                                       | `--watch`                                       |
| [`get_generation_log`](/testvibe-api/api-reference/generation/get_generation_log.md)       | `GET /projects/{project}/features/{feature}/generation/log`     | —                                               |
| [`cancel_generation`](/testvibe-api/api-reference/generation/cancel_generation.md)         | `POST /projects/{project}/features/{feature}/generation/cancel` | —                                               |
| [`run_feature`](/testvibe-api/api-reference/runs/run_feature.md)                           | `POST /projects/{project}/features/{feature}/run`               | `testvibe run <feature>`                        |
| [`wait_for_run`](/testvibe-api/api-reference/runs/wait_for_run.md)                         | *(poll the run route)*                                          | `--wait`                                        |
| [`get_run`](/testvibe-api/api-reference/runs/get_run.md)                                   | `GET /projects/{project}/runs/{runId}`                          | `testvibe runs show <runId>`                    |
| [`list_runs`](/testvibe-api/api-reference/runs/list_runs.md)                               | `GET /projects/{project}/runs`                                  | `testvibe runs list`                            |
| [`get_run_artifacts`](/testvibe-api/api-reference/runs/get_run_artifacts.md)               | `GET /projects/{project}/runs/{runId}/artifacts`                | `testvibe runs artifacts <runId>`               |
| [`list_files`](/testvibe-api/api-reference/files/list_files.md)                            | `GET /projects/{project}/files`                                 | `testvibe files list`                           |
| [`read_file`](/testvibe-api/api-reference/files/read_file.md)                              | `GET /projects/{project}/files/content?path=`                   | `testvibe files get <path>`                     |
| [`write_file`](/testvibe-api/api-reference/files/write_file.md)                            | `PUT /projects/{project}/files/content`                         | `testvibe files put <path> --file <local>`      |
| [`list_configs`](/testvibe-api/api-reference/configurations/list_configs.md)               | `GET /projects/{project}/configs`                               | `testvibe configs`                              |

{% hint style="info" %}
`wait_for_generation` and `wait_for_run` are client-side conveniences (the MCP server and CLI poll for you). Over raw REST, poll the corresponding `GET` route — see [Long-running operations](/testvibe-api/api-reference/async-operations.md).
{% endhint %}

Start with [Conventions & errors](/testvibe-api/api-reference/conventions.md) for the request/response basics shared by every page.


---

# 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/api-reference/reference.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.