Chatbot Training

Checks if retraining of the model is required

get

Required Permission: chatbots.training-status.get

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

Responses

200

Indicates whether training is required due to changes.

application/json

trainingRequiredbooleanRequired

Indicates whether retraining is required after changes to intents or examples.

Example: true

errorstringOptional

Optional error message.

403

Insufficient permissions.

get/v1/chatbots/{chatbotId}/training/required

GET /v1/chatbots/{chatbotId}/training/required HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "trainingRequired": true,
  "error": "text"
}