Bots

Bot instance management operations

---

List all bots

GET

/api/v1/platform/bots

Retrieve a list of all configured bot instances

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

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

TypeHTTP (bearer)

Responses

Successful response

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"bots": [

{

"uuid": "string",

"name": "string",

"adapter": "telegram",

"config": {

},

"created_at": "string",

"updated_at": "string"

}

]

}

}

GET

/api/v1/platform/bots

Playground

Server

Authorization

ApiKeyAuth

Samples

---

Create a new bot

POST

/api/v1/platform/bots

Create and configure a new bot instance

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

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

{

"name": "string",

"adapter": "string",

"config": {

}

}

Responses

Bot created successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"uuid": "string"

}

}

POST

/api/v1/platform/bots

Playground

Server

Authorization

ApiKeyAuth

Body

Samples

---

Get a specific bot

GET

/api/v1/platform/bots/{bot_uuid}

Retrieve details of a specific bot instance

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

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

bot_uuid*

Bot UUID

Typestring

Required

Format"uuid"

Responses

Successful response

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"bot": {

"uuid": "string",

"name": "string",

"adapter": "telegram",

"config": {

},

"created_at": "string",

"updated_at": "string"

}

}

}

GET

/api/v1/platform/bots/{bot_uuid}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

bot_uuid*

Samples

---

Update a bot

PUT

/api/v1/platform/bots/{bot_uuid}

Update the configuration of an existing bot instance

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

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

bot_uuid*

Typestring

Required

Format"uuid"

Request Body

application/json

{

"name": "string",

"config": {

}

}

Responses

Bot updated successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

PUT

/api/v1/platform/bots/{bot_uuid}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

bot_uuid*

Body

Samples

---

Delete a bot

DELETE

/api/v1/platform/bots/{bot_uuid}

Remove a bot instance from the system

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

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

bot_uuid*

Typestring

Required

Format"uuid"

Responses

Bot deleted successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

DELETE

/api/v1/platform/bots/{bot_uuid}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

bot_uuid*

Samples

---

Get bot event logs

POST

/api/v1/platform/bots/{bot_uuid}/logs

Retrieve event logs for a specific bot

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

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

bot_uuid*

Typestring

Required

Format"uuid"

Request Body

application/json

{

"from_index": -1,

"max_count": 10

}

Responses

Successful response

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"logs": [

{

}

],

"total_count": 0

}

}

POST

/api/v1/platform/bots/{bot_uuid}/logs

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

bot_uuid*

Body

Samples

---

Send Message

POST

/api/v1/platform/bots/{bot_uuid}/send_message

Send a message to a specific target via the specified bot

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

Parameters

Path Parameters

bot_uuid*

Bot UUID

Typestring

Required

Request Body

application/json

{

"target_type": "group",

"target_id": "123456789",

"message_chain": [

{

"type": "Plain",

"text": "Hello, World!"

}

]

}

Responses

Message sent successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"sent": true

}

}

POST

/api/v1/platform/bots/{bot_uuid}/send_message

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

bot_uuid*

Body

Samples

---

Powered by VitePress OpenAPI