Plugins
Package plugin is what each host is running, and how to change it: enable, disable, reload, or pin a service to a version.
Package plugin is what each host is running, and how to change it: enable, disable, reload, or pin a service to a version.
| Base URL | https://api.hanzo.ai |
| Operations | 4 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
plugins
DeleteAuthoredPlugin removes one of the caller org's built plugins, so the runtime can no longer load it.
DELETE /v1/plugins/authored/{id}
DeleteAuthoredPlugin removes one of the caller org's built plugins, so the runtime can no longer load it. Scoped to the caller's org, so an id belonging to another tenant answers 404 and is not deleted.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the plugin to remove, from the path. |
ListAuthoredPlugins lists the plugins the caller's org BUILT, newest first, each with the TypeScript as authored.
GET /v1/plugins/authored
ListAuthoredPlugins lists the plugins the caller's org BUILT, newest first, each with the TypeScript as authored. That is a different set with a different lifecycle from GET /v1/plugins, which reports the subsystems this deployment mounted. The bundled CommonJS the runtime executes is never included, and neither is any credential — a plugin names the connectors provider it needs and reads the credential from ctx.auth at run time.
post_v1_plugins_build
POST /v1/plugins/build
Request body — application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | — | |
provider | string | — | |
source | string | — | |
spec | string | — |
ListPlugins reports what this deployment actually mounted: every subsystem the composition root declared and whether it is switched on.
GET /v1/plugins
ListPlugins reports what this deployment actually mounted: every subsystem the composition root declared and whether it is switched on. A plugin here is MOUNTED CODE that extends the deployment's own surface — not a tool an agent calls — so this is an inventory and not a tool source. It is read off the same boot snapshot every traced request resolves its subsystem label against, so it cannot drift from what is serving. Enabled-only by default, because a caller asking what this deployment can do wants what is running; ?all=true adds the configured-but-off ones.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
all | query | string | — | All includes the configured-but-disabled subsystems too, but only when it is exactly the string "true". |
How is this guide?