Bots

Update Bot

Update bot

post
/v1/bot/{botId}/update

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

botIdstring* Required

Request Body * Required

Request Body Schema: application/json

namestring

The associated name

descriptionstring

The associated description

metaobject

Meta data information

modelstring

A model definition

backstorystring

The backstory this configuration is using

datasetIdstring

The id of the dataset this configuration is using

skillsetIdstring

The id of the skillset this configuration is using

privacyboolean

The privacy flag for this configuration

moderationboolean

The moderation flag for this configuration

blueprintIdstring

The ID of the blueprint

visibilitystring

The bot visibility

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.bot.update(

botId,
{
"name":"string",
"description":"string",
"meta":"object",
"model":"string",
"backstory":"string",
"datasetId":"string",
"skillsetId":"string",
"privacy":"boolean",
"moderation":"boolean",
"blueprintId":"string",
"visibility":"string"
}
)
{
"id":"string"
}
The bot was updated successfully