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

install_plugin

Enable a catalog plugin for this project.

Enable a plugin for this project — adds it to the project's plugin list, same as the Plugins view's Install button. Idempotent: installing an already-installed plugin succeeds unchanged, and builtin plugins are always on (a no-op).

Request

POST /api/v1/ops/projects/{project}/plugins/{slug}/install
Parameter
In
Type
Required
Description

project

path

string

yes

The project's public id.

slug

path

string

yes

The plugin's catalog slug.

curl -X POST -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/plugins/mailslurp-email/install"
testvibe plugins install mailslurp-email

Tool install_plugin — required slug, optional project.

Response

200 OK — the plugin document, same shape as a list_plugins entry:

{
  "slug": "mailslurp-email",
  "name": "MailSlurp Email",
  "installed": true,
  "requires": [
    { "name": "MAILSLURP_API_KEY", "kind": "secret", "set": false }
  ]
}

Check requires for values still to configure with set_variable / set_secret.

Errors

HTTP
When

404 not_found

No such project, or no such plugin slug in the catalog.

Last updated

Was this helpful?