For the complete documentation index, see llms.txt. This page is also available as Markdown.

Chatbot models

Lists all trained models for a chatbot

get

Required Permission: chatbots.models.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Responses
200

List of all models.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/models

Retrieves a specific trained model

get

Required Permission: chatbots.models.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

modelIdstringRequired

The ID of the model to be retrieved.

Responses
200

Details of the model.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/models/{modelId}

Retrieves evaluation results for a specific model

get

Required Permission: chatbots.models.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

modelIdstringRequired

The ID of the model to be evaluated.

Responses
200

Detailed evaluation metrics of the model.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/models/{modelId}/evaluation

Last updated