Chatbot endpoints (Client API: VDS)
6 FeatherPanel Client API: VDS endpoints from user/vds/chatbot.php: methods, paths, auth, permissions, rate limits, parameters and responses.
Last synced from FeatherPanel 15b94e9 on .
On this page
Defined in backend/app/routes/user/vds/chatbot.php. Authentication used here: Signed-in user. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.
Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.
Endpoints
POST/api/user/vds-chatbot/chat
Send a message to the VDS AI chatbot Send a message to the VDS AI assistant and receive a response. Optionally include chat history for context.
Request body: VdsChatbotRequest (application/json)
| Body field | Type | Required | Description |
|---|---|---|---|
message | string | yes | User message |
history | object[] | no | Chat history |
Response data field | Type | Description |
|---|---|---|
response | string |
curl -X POST "$PANEL_URL/api/user/vds-chatbot/chat" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"message":"","history":[]}'Responses: 200 Chat response received successfully · 400 Invalid request · 401 Unauthorized
POST/api/user/vds-chatbot/chat/stream
curl -X POST "$PANEL_URL/api/user/vds-chatbot/chat/stream" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"GET/api/user/vds-chatbot/conversations
Get user VDS chatbot conversations Retrieve all VDS chatbot conversations for the authenticated user.
Response data field | Type | Description |
|---|---|---|
conversations | object[] |
curl -X GET "$PANEL_URL/api/user/vds-chatbot/conversations" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Conversations retrieved successfully · 401 Unauthorized
GET/api/user/vds-chatbot/conversations/{id}
Get VDS chatbot conversation messages Retrieve all messages for a specific VDS chatbot conversation.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Conversation ID |
Response data field | Type | Description |
|---|---|---|
conversation | object | |
messages | object[] |
curl -X GET "$PANEL_URL/api/user/vds-chatbot/conversations/$ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Messages retrieved successfully · 401 Unauthorized · 404 Conversation not found
DELETE/api/user/vds-chatbot/conversations/{id}
Delete VDS chatbot conversation Delete a VDS chatbot conversation and all its messages.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Conversation ID |
curl -X DELETE "$PANEL_URL/api/user/vds-chatbot/conversations/$ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:chatbot:conversation:delete
Responses: 200 Conversation deleted successfully · 401 Unauthorized · 404 Conversation not found
PATCH/api/user/vds-chatbot/conversations/{id}/memory
Update VDS chatbot conversation memory Update the memory field for a VDS chatbot conversation. This memory is included in the AI context for future messages.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Conversation ID |
| Body field | Type | Required | Description |
|---|---|---|---|
memory | string | no | Memory content |
curl -X PATCH "$PANEL_URL/api/user/vds-chatbot/conversations/$ID/memory" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"memory":""}'Plugin events: featherpanel:chatbot:conversation:memory:update
Responses: 200 Memory updated successfully · 401 Unauthorized · 404 Conversation not found