Plugins

Plugin installation and management operations

---

List All Plugins

GET

/api/v1/plugins

Get list of all installed plugins

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Responses

Success

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"plugins": [

{

}

]

}

}

GET

/api/v1/plugins

Playground

Server

Authorization

BearerAuth

Samples

---

Get Plugin Details

GET

/api/v1/plugins/{author}/{plugin_name}

Get details of a specific plugin

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

author*

Plugin author

Typestring

Required

plugin_name*

Plugin name

Typestring

Required

Responses

Success

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"plugin": {

}

}

}

GET

/api/v1/plugins/{author}/{plugin_name}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

author*

plugin_name*

Samples

---

Delete Plugin

DELETE

/api/v1/plugins/{author}/{plugin_name}

Uninstall the specified plugin

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

author*

Plugin author

Typestring

Required

plugin_name*

Plugin name

Typestring

Required

Query Parameters

delete_data

Whether to delete plugin data

Typeboolean

Defaultfalse

Responses

Deletion task created

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"task_id": "string"

}

}

DELETE

/api/v1/plugins/{author}/{plugin_name}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

author*

plugin_name*

delete_data

Samples

---

Install Plugin from Local File

POST

/api/v1/plugins/install/local

Upload and install plugin package file

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Request Body

multipart/form-data

object

Plugin package file (.lbpkg format)

Format"binary"

Responses

Installation task created

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"task_id": "string"

}

}

POST

/api/v1/plugins/install/local

Playground

Server

Authorization

BearerAuth

Body

Samples

---

Install Plugin from GitHub

POST

/api/v1/plugins/install/github

Install plugin from GitHub Release

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Request Body

application/json

{

"asset_url": "string",

"owner": "string",

"repo": "string",

"release_tag": "string"

}

Responses

Installation task created

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"task_id": "string"

}

}

POST

/api/v1/plugins/install/github

Playground

Server

Authorization

BearerAuth

Body

Samples

---

Install from Marketplace

POST

/api/v1/plugins/install/marketplace

Install plugin from LangBot plugin marketplace

Authorizations

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Request Body

application/json

{

"plugin_id": "string"

}

Responses

Installation task created

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"task_id": "string"

}

}

POST

/api/v1/plugins/install/marketplace

Playground

Server

Authorization

BearerAuth

Body

Samples

---