Bot

Fetch a bot

get/bot/{botId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/bot/{botId}/fetch
  • Auth: HTTP bearer

Path parameters

botIdstring required

The ID of the bot to retrieve

Response

The bot was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

modelstring

A model definition

backstorystring nullable

The backstory this configuration is using

datasetIdstring nullable

The id of the dataset this configuration is using

skillsetIdstring nullable

The id of the skillset this configuration is using

privacyboolean

The privacy flag for this configuration

moderationboolean

The moderation flag for this configuration

blueprintIdstring nullable

The ID of the blueprint

visibility'private' | 'protected' | 'public'

The bot visibility

Example response

{
  "model": "gpt-5.4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.