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

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Query parameters

searchTermstringOptional

Term being searched. This expects one optional String matching the name of an answer.

pageinteger · int32Required

Current page, starting at 1

Default: 1Example: 1

sizeinteger · int32Required

Size of the page

Default: 5Example: 1

orderBystringOptional

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

Default: updatedAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer?page=1&size=5 HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "updatedAt": "2025-06-30T22:27:37.760Z",
        "updatedBy": "text",
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "webhook": "text",
        "type": "text",
        "headers": {},
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "content": {},
              "description": "text",
              "type": "text",
              "buttons": [
                {}
              ],
              "quickReply": [
                {}
              ],
              "name": "text"
            },
            "type": "text",
            "channelTypeId": 1,
            "channelId": "text",
            "technicalText": "text"
          }
        ],
        "executionLimit": 1,
        "user": {
          "name": "text",
          "imageUrl": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "empty": true
}

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

get

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Query parameters

searchTermstringOptional

Term being searched. This expects one optional String matching the name of an answer.

pageinteger · int32Required

Current page, starting at 1

Default: 1Example: 1

sizeinteger · int32Required

Size of the page

Default: 5Example: 1

orderBystringOptional

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

Default: updatedAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected?page=1&size=5 HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "last": true,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "updatedAt": "2025-06-30T22:27:37.760Z",
        "updatedBy": "text",
        "tags": [
          {
            "uuid": "text",
            "name": "text"
          }
        ],
        "webhook": "text",
        "type": "text",
        "headers": {},
        "answerTemplates": [
          {
            "id": "text",
            "content": {
              "content": {},
              "description": "text",
              "type": "text",
              "buttons": [
                {}
              ],
              "quickReply": [
                {}
              ],
              "name": "text"
            },
            "type": "text",
            "channelTypeId": 1,
            "channelId": "text",
            "technicalText": "text"
          }
        ],
        "executionLimit": 1,
        "user": {
          "name": "text",
          "imageUrl": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "empty": true
}

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot uuid to search

Query parameters

searchTermstringRequired

Term being searched

limitinteger · int32Optional

How many items will be returned in the list. Defaults to 6.

Default: 6Example: 1

Responses

200

Ok

application/json

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot uuid to search

Query parameters

searchTermstringRequired

Term being searched

limitinteger · int32Optional

How many items will be returned in the list. Defaults to 6.

Default: 6Example: 1

Responses

200

Ok

application/json

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

CRUD Methods

Retrieves information from a specific given answer.

get

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

uuidstringRequired

The answer's uuid

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid} HTTP/1.1
Host: 
Accept: */*

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "updatedAt": "2025-06-30T22:27:37.760Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "headers": {},
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ],
          "name": "text"
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "executionLimit": 1,
    "user": {
      "name": "text",
      "imageUrl": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Creates a brand new answer

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

namestringRequired

The answer's name.

descriptionstringOptional

A freeform description of this answer.

webhookstringOptional

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

transactionalbooleanRequired

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

evaluablebooleanRequired

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

headersobjectOptional

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

typestringOptional

The answer's type.

executionLimitinteger · int64Optional

The number of times an answer can be executed.

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "uuid": "text",
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "webhook": "text",
  "transactional": true,
  "evaluable": true,
  "headers": {},
  "type": "text",
  "executionLimit": 1
}

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "updatedAt": "2025-06-30T22:27:37.760Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "headers": {},
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ],
          "name": "text"
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "executionLimit": 1,
    "user": {
      "name": "text",
      "imageUrl": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates an existing answer.

put

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

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

uuidstringRequired

The answer's uuid

Body

namestringRequired

The answer's name.

descriptionstringOptional

A freeform description of this answer.

webhookstringOptional

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

transactionalbooleanRequired

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

evaluablebooleanRequired

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

headersobjectOptional

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

typestringOptional

The answer's type.

executionLimitinteger · int64Optional

The number of times an answer can be executed.

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "uuid": "text",
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "webhook": "text",
  "transactional": true,
  "evaluable": true,
  "headers": {},
  "type": "text",
  "executionLimit": 1
}

{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "updatedAt": "2025-06-30T22:27:37.760Z",
    "updatedBy": "text",
    "tags": [
      {
        "uuid": "text",
        "name": "text"
      }
    ],
    "webhook": "text",
    "type": "text",
    "headers": {},
    "answerTemplates": [
      {
        "id": "text",
        "content": {
          "content": {},
          "description": "text",
          "type": "text",
          "buttons": [
            {}
          ],
          "quickReply": [
            {}
          ],
          "name": "text"
        },
        "type": "text",
        "channelTypeId": 1,
        "channelId": "text",
        "technicalText": "text"
      }
    ],
    "executionLimit": 1,
    "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

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

uuidstringRequired

The answer's uuid

Responses

200

Ok

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid} HTTP/1.1
Host: 
Accept: */*

No content

Other Listings

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

get

Path parameters

orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Responses

200

Ok

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/list-on-flow HTTP/1.1
Host: 
Accept: */*

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