Read All

HTTP Request

GET https://api.botfuel.io/trainer/api/v0/intents

Response structure

The response structure has three components: "_content", "_count" and "_links". "_count" and "_links" are purely used for pagination, while "_content" has the information on the Intents for the bot. The following parameters are from the "_content" component.

Parameter Type Description
description Array Description of this Intent
id String Unique identifier for this Intent
label String Given label for this Intent
resolvePrompt String Text displayed to user when bot identifies several QnAs or Intents
trainingScore Integer Integer between 0 and 1 representing how well-trained the Intent is
utterances Array Array of phrases to trigger this Intent

Example

curl -H "App-Id: $BOTFUEL_APP_ID" \
-H "App-Key: $BOTFUEL_APP_KEY" \
-X GET 'https://api.botfuel.io/trainer/api/v0/intents'
// Response
{
  "_content": [
    {
      "description": "This is an intent to describe intents",
      "id": "5b559dd3e44b330012882a88",
      "label": "intent-label",
      "resolvePrompt": "Triggering intents",
      "trainingScore": 1,
      "utterances": [
        {
          "value": "First way of triggering this Intent"
        },
        {
          "value": "Second way of triggering this Intent"
        }
      ]
    }
  ],
  "_count": {
    "elements": 1,
    "pages": 1
  },
  "_links": {
    "hasNext": false,
    "hasPrevious": false,
    "next": null,
    "previous": null,
    "self": "api/v0/intents"
  }
}