Get Installed Plugin Endpoint - OpenHands Docs

Get Installed Plugin Endpoint

curl --request GET \
  --url https://api.example.com/api/plugins/installed/{plugin_name} \
  --header 'X-Session-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/plugins/installed/{plugin_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/plugins/installed/{plugin_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/plugins/installed/{plugin_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Session-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/plugins/installed/{plugin_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "install_path": "<string>",
  "installed_at": "<string>",
  "name": "<string>",
  "source": "<string>",
  "description": "",
  "enabled": true,
  "files": [
    "<string>"
  ],
  "repo_path": "<string>",
  "resolved_ref": "<string>",
  "skills": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "version": ""
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

GET

/

api

/

plugins

/

installed

/

{plugin_name}

Get Installed Plugin Endpoint

curl --request GET \
  --url https://api.example.com/api/plugins/installed/{plugin_name} \
  --header 'X-Session-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/plugins/installed/{plugin_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/plugins/installed/{plugin_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/plugins/installed/{plugin_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Session-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/plugins/installed/{plugin_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "install_path": "<string>",
  "installed_at": "<string>",
  "name": "<string>",
  "source": "<string>",
  "description": "",
  "enabled": true,
  "files": [
    "<string>"
  ],
  "repo_path": "<string>",
  "resolved_ref": "<string>",
  "skills": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "version": ""
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

X-Session-API-Key

string

header

required

Path Parameters

plugin_name

string

required

Plugin name (lowercase alphanumeric, hyphens)

Required string length: 1 - 255

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

Successful Response

Response containing installed plugin information.

install_path

string

required

Path where the plugin is installed

installed_at

string

required

ISO 8601 timestamp of installation

name

string

required

Plugin name

source

string

required

Original source (e.g., 'github:owner/repo')

description

string

default:""

Plugin description

enabled

boolean

default:true

Whether the plugin is enabled

files

string[] | null

Plugin files, relative to install_path (None if load failed)

repo_path

string | null

Subdirectory path within the repository

resolved_ref

string | null

Resolved git commit SHA

skills

PluginSkillSummary · object[] | null

Skills bundled in the plugin (None if it failed to load)

Show child attributes

version

string

default:""

Plugin version