| Property | Value |
|---|---|
| Method | GET |
| Endpoint | https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}} |
| Content Type | application/json |
| Authorization | auth: {{JWT}} — See How to generate the JWT Token. |
| API Scope | App Builder: Train FAQ; Admin Console: Test and Train > Train FAQ |
Path Parameters
| Parameter | Description | Required |
|---|---|---|
host | The environment URL. For example, https://platform.kore.ai | Required |
BotId | Bot ID or Stream ID, accessible under General Settings on the App Builder. | Required |
language | The bot language code. For example, en for English and de for German. | Required |
state | The bot state: configured for the In-Development version, published for the Published version. Defaults to configured. | Optional |
Sample Request
curl -X GET \
'https://{{host}}/api/public/bot/{{bot_id}}/faqs/train/status?language=en' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json'
Body Parameters
No body parameters are passed.Sample Response
Successful training:{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "Success",
"status": "success",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}
{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "in-progress",
"status": "in-progress",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}
{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "failure",
"status": "failure",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}