NEnetxms
Chat Bots

Create a chat bot

Changed on

Create a new chat bot with the specified driver and configuration. A notification channel with the same name is registered automatically.

post/v1/chat-bots

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/chat-bots
  • Auth
    HTTP bearer

Request body

namestring required

Unique chat bot name

descriptionstring

Chat bot description

driverNamestring required

Chat bot driver name

configurationstring

Driver-specific configuration text

idleTimeoutinteger

Session idle timeout in seconds

providerSlotstring

AI provider slot for bot sessions (empty for default)

Response

Chat bot created 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