Chatbot expressions

Lists and filters user inputs (expressions)

get

Required Permission: chatbots.expressions.list

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

Query parameters

limitnumberOptional

The limit for how many examples should be fetched.

pageTokenstringOptional

The date after which to filter examples. Only examples after this date will be fetched.

intentIdstringOptional

Filters by a specific intent ID.

maxScorenumberOptional

Filters for expressions with a confidence score less than or equal to this value.

languagestringOptional

The language of the examples.

Responses

200

List of expressions.

application/json

pageTokenstringRequired

The date of the latest fetched example.

Example: 2025-09-29T07:08:00Z

errorstringOptional

Optional error message.

403

Insufficient permissions.

get

/v1/chatbots/{chatbotId}/expressions

HTTPcURLJavaScriptPython

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

{
  "pageToken": "2025-09-29T07:08:00Z",
  "expressions": [
    {
      "id": "59aBv7wzR9cxd1Pxyz",
      "created": "2025-10-02T11:00:00Z",
      "expression": "Where is my package?",
      "intents": [
        {
          "category": "Order status",
          "confidenceScore": 0.7
        }
      ],
      "predictedIntentId": "Kq8BxZaJd2wZR9cxd1P",
      "predictionScore": 0.95,
      "requiredIntentPredictionScore": 0.7,
      "topIntent": {
        "category": "Order status",
        "confidenceScore": 0.7
      },
      "versionId": "59aBv7wzR9cxd1Pxyz",
      "language": "DE",
      "conversationId": "Kq8BxZaJd2wZR9cxd1P"
    }
  ],
  "error": "text"
}

Retrieves statistics for recorded expressions

get

Required Permission: chatbots.expressions.list

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

Responses

200

Statistical evaluation.

application/json

totalnumberRequired

Total number of expressions.

Example: 1250

averagePredictionScorenumber · max: 1Required

Average confidence score of all expressions.

Example: 0.89

errorstringOptional

Optional error message.

403

Insufficient permissions.

get

/v1/chatbots/{chatbotId}/expressions/stats

HTTPcURLJavaScriptPython

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

{
  "total": 1250,
  "averagePredictionScore": 0.89,
  "totals": {
    "80": 200,
    "90": 300,
    "100": 500
  },
  "error": "text"
}

Deletes an expression

delete

Required Permission: chatbots.expressions.delete

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

expressionIdstringRequired

The ID of the expression to delete.

Responses

200

Result of the deletion process.

application/json

deletedbooleanRequired

Indicates whether the deletion was successful.

Example: true

errorstringOptional

Optional error message.

403

Insufficient permissions.

delete

/v1/chatbots/{chatbotId}/expressions/{expressionId}

HTTPcURLJavaScriptPython

DELETE /v1/chatbots/{chatbotId}/expressions/{expressionId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

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