---
title: "Get chat bot details"
method: GET
path: "/v1/chat-bots/{bot-name}"
tags: ["Chat Bots"]
---

# Get chat bot details

`GET /v1/chat-bots/{bot-name}`

Retrieve details of a specific chat bot.

## Path parameters

- `bot-name` string, required

## Response `200`

Chat bot details retrieved 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

- `403` — Access denied
- `404` — Chat bot not found

---

[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/ee1f54ee3abd/schema)