Assistants

The bots endpoint is used to get informations about a Virtual Agent with its Prisme_Developer_Token.

URL : api.prisme.ai/v1/bots

Method : GET

Request example

curl -X GET \
  https://api.prisme.ai/v1/bots \
  -H 'authorization: Bearer Prisme_Developer_Token' \
  -H 'content-type: application/json' \

Headers

In the request URL, provide the following headers with values.

Key	Value
Content-Type	application/json
Authorization	Bearer Prisme_Developer_Token

Success Response

Condition : No required parameter missing and Prisme_Developer_Token is known by the platform.

Code : 200

Content example

{
    "name": "CoffeeShop",
    "photo": {
        "url": "..."
    },
    "developer": "Prisme.ai",
    "clientToken": "Prisme_Client_Token",
    "developerToken": "Prisme_Developer_Token",
    "lang": "fr",
    "description": "Ordering a beverage in a coffee shop",
    "languages": ["fr","en"],
    "nlu": "prisme.ai",
    "satisfactionOption": null
}

Response body

The following parameters are send in the response body.

Parameter	Type	Description
name	String	Name of the Assistant
photo	Object	Contain the URL of Assistant picture
clientToken	String	Token that is used to call the Assistant (for instance: /message)
developerToken	String	Token that is used to manage the Assistant
lang	String	the language
description	String	General information about the Assistant
nlu	String	NLU of your Assistant
satisfactionOption	Boolean	True if the Assistant randomly asks for user satisfaction