---
title: "Create a chat bot"
method: POST
path: "/v1/chat-bots"
tags: ["Chat Bots"]
---

# Create a chat bot

`POST /v1/chat-bots`

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

## Request body

- object
  - `name` string, required — Unique chat bot name
  - `description` string — Chat bot description
  - `driverName` string, required — Chat bot driver name
  - `configuration` string — Driver-specific configuration text
  - `idleTimeout` integer — Session idle timeout in seconds
  - `providerSlot` string — AI provider slot for bot sessions (empty for default)
  - `userMappings` object[] — Platform peer ID to NetXMS user ID mappings
    - `peerId` string — Platform-specific peer ID
    - `userId` integer — NetXMS user ID

## Response `201`

Chat bot created successfully

- ChatBot
  - `name` string — Chat bot name
  - `description` string — Chat bot description
  - `driverName` string — Chat bot driver name
  - `configuration` string — Driver-specific configuration text
  - `driverInitialized` boolean — Whether the driver was initialized and started successfully
  - `healthCheckStatus` boolean — Health check status
  - `idleTimeout` integer — Session idle timeout in seconds
  - `providerSlot` string — AI provider slot for bot sessions (empty for default)
  - `activeSessions` integer — Number of currently active chat sessions
  - `lastInboundMessageTime` string — Timestamp of last inbound message
  - `errorMessage` string — Last error message
  - `userMappings` object[] — Platform peer ID to NetXMS user ID mappings
    - `peerId` string — Platform-specific peer ID
    - `userId` integer — NetXMS user ID

## Other responses

- `400` — Invalid or missing required fields
- `403` — Access denied
- `409` — Chat bot with this name already exists

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/14d93e5115dd/schema)