Answer API

Answers are what we return when the conversation API identifies what the user's request are, according to our dialog manager.

API SUBPATH: eva-answer

Pagination and search

Searches and paginates through expected answers -- those being of type 'TYPE_ANSWER' and 'WELCOME_MESSAGE'.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

Body

totalPagesinteger (int32)

totalElementsinteger (int64)

firstboolean

lastboolean

pageablePageableObject (object)

numberOfElementsinteger (int32)

sortSort (object)

sizeinteger (int32)

contentarray of AnswersDTO (object)

numberinteger (int32)

emptyboolean

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "first": false,
  "last": false,
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "updatedAt": "2024-11-21T06:29:48.751Z",
        "updatedBy": "text",
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "webhook": "text",
        "type": "text",
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "description": "text",
              "type": "text",
              "buttons": [],
              "quickReply": [],
              "name": "text"
            },
            "type": "text",
            "channelId": "text",
            "technicalText": "text"
          }
        ],
        "user": {
          "name": "text",
          "imageUrl": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "empty": false
}

Paginates through not expected answers -- those being of type 'FIRST_CELL' and 'TYPE_ANYTHING_ELSE'.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

Body

totalPagesinteger (int32)

totalElementsinteger (int64)

firstboolean

lastboolean

pageablePageableObject (object)

numberOfElementsinteger (int32)

sortSort (object)

sizeinteger (int32)

contentarray of AnswersDTO (object)

numberinteger (int32)

emptyboolean

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "first": false,
  "last": false,
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "updatedAt": "2024-11-21T06:29:48.751Z",
        "updatedBy": "text",
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "webhook": "text",
        "type": "text",
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "description": "text",
              "type": "text",
              "buttons": [],
              "quickReply": [],
              "name": "text"
            },
            "type": "text",
            "channelId": "text",
            "technicalText": "text"
          }
        ],
        "user": {
          "name": "text",
          "imageUrl": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "empty": false
}

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANYTHING_ELSE' and 'FIRST_CELL', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot uuid to search

Query parameters

Response

Body

itemsstring

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  "text"
]

Searches (greedily) for any answer names that exists in a bot, matching types 'TYPE_ANSWER' and 'WELCOME_MESSAGE', matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot uuid to search

Query parameters

Response

Body

itemsstring

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  "text"
]

CRUD Methods

Retrieves information from a specific given answer.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

uuid*string

The answer's uuid

Response

Body

answerAnswerDTO (object)

A Structure representing all data of an answer, containing it's templates.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this answer

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "updatedAt": "2024-11-21T06:29:48.751Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "description": "text",
          "type": "text",
          "buttons": [],
          "quickReply": [],
          "name": "text"
        },
        "type": "text",
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "user": {
      "name": "text",
      "imageUrl": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Creates a brand new answer

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Body

name*string

The answer's name.

descriptionstring

A freeform description of this answer.

tagsarray of TagsDTO (object)

A list of all tags associated to this answer.

answerTemplates*array of AnswerTemplateRequestDTO (object)

A list of the answer's templates.

webhookstring

A freeform string to code up a webhook for this answer.

transactional*boolean

A boolean indicator representing if this answer is a transactional answer.

evaluable*boolean

A boolean indicator representing if this answer is an evaluable answer.

headersobject

The answer's Headers. This object is a freeform JSON which must be parser as an object when receiving it.

typestring

The answer's type.

executionLimitinteger (int64)

The number of times an answer can be executed.

Response

Body

answerAnswerDTO (object)

A Structure representing all data of an answer, containing it's templates.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this answer

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerTemplates": [
        {
          "channelId": "text"
        }
      ],
      "evaluable": false,
      "name": "text",
      "transactional": false
    }),
});
const data = await response.json();

Response

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "updatedAt": "2024-11-21T06:29:48.751Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "description": "text",
          "type": "text",
          "buttons": [],
          "quickReply": [],
          "name": "text"
        },
        "type": "text",
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "user": {
      "name": "text",
      "imageUrl": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates an existing answer.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

uuid*string

The answer's uuid

Body

name*string

The answer's name.

descriptionstring

A freeform description of this answer.

tagsarray of TagsDTO (object)

A list of all tags associated to this answer.

answerTemplates*array of AnswerTemplateRequestDTO (object)

A list of the answer's templates.

webhookstring

A freeform string to code up a webhook for this answer.

transactional*boolean

A boolean indicator representing if this answer is a transactional answer.

evaluable*boolean

A boolean indicator representing if this answer is an evaluable answer.

headersobject

The answer's Headers. This object is a freeform JSON which must be parser as an object when receiving it.

typestring

The answer's type.

executionLimitinteger (int64)

The number of times an answer can be executed.

Response

Body

answerAnswerDTO (object)

A Structure representing all data of an answer, containing it's templates.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this answer

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerTemplates": [
        {
          "channelId": "text"
        }
      ],
      "evaluable": false,
      "name": "text",
      "transactional": false
    }),
});
const data = await response.json();

Response

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "updatedAt": "2024-11-21T06:29:48.751Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "description": "text",
          "type": "text",
          "buttons": [],
          "quickReply": [],
          "name": "text"
        },
        "type": "text",
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "user": {
      "name": "text",
      "imageUrl": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Deletes an existing answer. The answer is disabled via the 'removed' parameter being set to true, rather than deleted from the DB.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

uuid*string

The answer's uuid

Response

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Other Listings

Searches through all answers recently used on a given bot to start a flow.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/list-on-flow

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Response

Body

idstring

The answer's String uuid.

namestring

The answer's name.

typestring

The answer's type.

executionLimitinteger (int64)

The number of times an answer can be executed.

answerTemplatesarray of AnswerTemplateResponseDTO (object)

A list of the answer's templates.

tagsarray of TagOnFlowDTO (object)

A list of all tags associated to this answer.

Request

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/list-on-flow', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "type": "text",
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "description": "text",
          "type": "text",
          "buttons": [],
          "quickReply": [],
          "name": "text"
        },
        "type": "text",
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "tags": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
]

PreviousKnowledge AI NLP NextAutomated Tests

Last updated 3 months ago