Install a plugin

Base URL: https://{kibana_url}

POST /api/agent_builder/plugins/install
POST /s/{space_id}/api/agent_builder/plugins/install

Auth

Install a plugin from a GitHub Claude plugin URL or a direct ZIP URL. Plugins bundle agent capabilities such as skills. To learn more about Agent Builder plugins, refer to the plugins documentation.

Required privileges

Privileges agentBuilder:write

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

plugin_name string: Optional name override for the plugin. Defaults to the manifest name.
url string required: URL to install the plugin from (GitHub URL or direct zip URL).

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request for installing a plugin from a GitHub URL

Console Kibana Dev Tools

POST kbn://api/agent_builder/plugins/install
{
  "url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis"
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/agent_builder/plugins/install" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis"
}'

Response

Example response returning the definition of the installed plugin

{
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "Financial analysis tools and skills for Claude",
  "id": "financial-analysis",
  "manifest": {
    "author": {
      "name": "Anthropic",
      "url": "https://www.anthropic.com"
    },
    "keywords": [
      "finance",
      "analysis"
    ],
    "repository": "https://github.com/anthropics/financial-services-plugins"
  },
  "name": "financial-analysis",
  "skill_ids": [
    "financial-analysis-analyze-portfolio"
  ],
  "source_url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis",
  "unmanaged_assets": {
    "agents": [],
    "hooks": [],
    "lsp_servers": [],
    "mcp_servers": [],
    "output_styles": []
  },
  "updated_at": "2025-01-01T00:00:00.000Z",
  "version": "1.0.0"
}

Request Console 1 / 2 languages

Example request for installing a plugin from a direct zip URL

Console Kibana Dev Tools

POST kbn:/api/agent_builder/plugins/install
{
  "url": "https://my-server.example.com/my-plugin.zip"
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/agent_builder/plugins/install" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://my-server.example.com/my-plugin.zip"
  }'

Generated from the API spec

Response

Example response returning the definition of the installed plugin

{
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "Financial analysis tools and skills for Claude",
  "id": "financial-analysis",
  "manifest": {
    "author": {
      "name": "Anthropic",
      "url": "https://www.anthropic.com"
    },
    "keywords": [
      "finance",
      "analysis"
    ],
    "repository": "https://github.com/anthropics/financial-services-plugins"
  },
  "name": "financial-analysis",
  "skill_ids": [
    "financial-analysis-analyze-portfolio"
  ],
  "source_url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis",
  "unmanaged_assets": {
    "agents": [],
    "hooks": [],
    "lsp_servers": [],
    "mcp_servers": [],
    "output_styles": []
  },
  "updated_at": "2025-01-01T00:00:00.000Z",
  "version": "1.0.0"
}

Request Console 1 / 2 languages

Example request for installing a plugin with a custom name

Console Kibana Dev Tools

POST kbn:/api/agent_builder/plugins/install
{
  "plugin_name": "my-custom-plugin-name",
  "url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis"
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/agent_builder/plugins/install" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
    "plugin_name": "my-custom-plugin-name",
    "url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis"
  }'

Generated from the API spec

Response

Example response returning the definition of the installed plugin

{
  "created_at": "2025-01-01T00:00:00.000Z",
  "description": "Financial analysis tools and skills for Claude",
  "id": "financial-analysis",
  "manifest": {
    "author": {
      "name": "Anthropic",
      "url": "https://www.anthropic.com"
    },
    "keywords": [
      "finance",
      "analysis"
    ],
    "repository": "https://github.com/anthropics/financial-services-plugins"
  },
  "name": "financial-analysis",
  "skill_ids": [
    "financial-analysis-analyze-portfolio"
  ],
  "source_url": "https://github.com/anthropics/financial-services-plugins/tree/main/financial-analysis",
  "unmanaged_assets": {
    "agents": [],
    "hooks": [],
    "lsp_servers": [],
    "mcp_servers": [],
    "output_styles": []
  },
  "updated_at": "2025-01-01T00:00:00.000Z",
  "version": "1.0.0"
}

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body