NEnetxms
Chat Bots

Get chat bot details

Changed on

Retrieve details of a specific chat bot.

get/v1/chat-bots/{bot-name}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/chat-bots/{bot-name}
  • Auth
    HTTP bearer

Path parameters

bot-namestring required

Chat bot name

Response

Chat bot details retrieved successfully

namestring

Chat bot name

descriptionstring

Chat bot description

driverNamestring

Chat bot driver name

configurationstring

Driver-specific configuration text

driverInitializedboolean

Whether the driver was initialized and started successfully

healthCheckStatusboolean

Health check status

idleTimeoutinteger

Session idle timeout in seconds

providerSlotstring

AI provider slot for bot sessions (empty for default)

activeSessionsinteger

Number of currently active chat sessions

lastInboundMessageTimestring

Timestamp of last inbound message

errorMessagestring

Last error message

Changes