User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • ๐Ÿš€GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • ๐Ÿ’ฌBUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • โœจGENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • ๐ŸŒCHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • โš™๏ธCONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • ๐Ÿ“ŠANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Answer

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

PreviousKnowledge AI NLPNextAutomated Tests

Last updated 2 months ago

Was this helpful?

API SUBPATH: eva-answer

Pagination and Listing

CRUD Methods

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

get
Path parameters
orgUUIDstringRequired

It is the organization where the answers are, it is used to connect to the correct database

envUUIDstringRequired

It is the environment where the answers are, it is used to connect to the correct database

botUUIDstringRequired

It is the bot where the answers are, it is used to filter answers

Query parameters
pageinteger ยท int32Required

Current page, starting at 1

Default: 1Example: 1
sizeinteger ยท int32Required

Size of the page

Default: 5Example: 1
rephrasingFilterstringOptional

Whether you are filtering for ANY answer, STATIC_ONLY or REPHRASE_ONLY.

Default: ANY
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
searchTermstringOptional

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

maskingFilterstring ยท enumOptional

Used to filter masked answers, defaulted to ALL

Default: ALLPossible values:
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
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer?page=1&size=1 HTTP/1.1
Host: 
Accept: */*
{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "isMasked": true,
        "updatedAt": "2025-05-11T11:37:39.548Z",
        "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",
            "translations": [
              {
                "answerTemplateUUID": "text",
                "locale": "text",
                "content": "text"
              }
            ]
          }
        ],
        "executionLimit": 1,
        "rephraseEnabled": true,
        "rephrasingTemperature": 1,
        "rephrasingMemory": 1,
        "rephrasingBlacklist": "text",
        "user": {
          "name": "text",
          "imageUrl": "text"
        },
        "transactionalAuth": {
          "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
          "basicToken": "text",
          "bearerToken": "text",
          "oauthUrl": "text",
          "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
          "clientId": "text",
          "clientSecret": "text",
          "authUsername": "text",
          "authPassword": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "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
pageinteger ยท int32Required

Current page, starting at 1

Default: 1Example: 1
sizeinteger ยท int32Required

Size of the page

Default: 5Example: 1
rephrasingFilterstringOptional

Whether you are filtering for ANY answer, STATIC_ONLY or REPHRASING_ONLY.

Default: ANY
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
searchTermstringOptional

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

maskingFilterstring ยท enumOptional

Used to filter masked answers, defaulted to ALL

Default: ALLPossible values:
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
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected?page=1&size=1 HTTP/1.1
Host: 
Accept: */*
{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "answer": {
        "id": "text",
        "name": "text",
        "description": "text",
        "evaluable": 1,
        "transactional": 1,
        "isMasked": true,
        "updatedAt": "2025-05-11T11:37:39.548Z",
        "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",
            "translations": [
              {
                "answerTemplateUUID": "text",
                "locale": "text",
                "content": "text"
              }
            ]
          }
        ],
        "executionLimit": 1,
        "rephraseEnabled": true,
        "rephrasingTemperature": 1,
        "rephrasingMemory": 1,
        "rephrasingBlacklist": "text",
        "user": {
          "name": "text",
          "imageUrl": "text"
        },
        "transactionalAuth": {
          "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
          "basicToken": "text",
          "bearerToken": "text",
          "oauthUrl": "text",
          "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
          "clientId": "text",
          "clientSecret": "text",
          "authUsername": "text",
          "authPassword": "text"
        }
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Retrieves info 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
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,
    "isMasked": true,
    "updatedAt": "2025-05-11T11:37:39.548Z",
    "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",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ],
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "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

This class contains all the necessary information for different authentication types. It validates whether the provided authentication data is complete based on the specified type.

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.

isMaskedbooleanOptional

Whether or not this answer is masked.

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.

rephraseEnabledbooleanOptional

Wether the rephrasing feature is active in this answer.

rephrasingTemperaturenumber ยท doubleOptional

The temperature used in the rephrasing feature for this answer.

rephrasingMemoryinteger ยท int32Optional

The ammount of previous user inputs used to modify the rephrasing feature.

rephrasingBlackliststringOptional

A number os space-separated blacklisted words to evoid during rephrasing.

validAuthTypebooleanOptional
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
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 757

{
  "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,
  "isMasked": true,
  "headers": {},
  "type": "text",
  "executionLimit": 1,
  "rephraseEnabled": true,
  "rephrasingTemperature": 1,
  "rephrasingMemory": 1,
  "rephrasingBlacklist": "text",
  "transactionalAuth": {
    "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "validAuthType": true
}
{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "isMasked": true,
    "updatedAt": "2025-05-11T11:37:39.548Z",
    "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",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ],
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates an 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

This class contains all the necessary information for different authentication types. It validates whether the provided authentication data is complete based on the specified type.

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.

isMaskedbooleanOptional

Whether or not this answer is masked.

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.

rephraseEnabledbooleanOptional

Wether the rephrasing feature is active in this answer.

rephrasingTemperaturenumber ยท doubleOptional

The temperature used in the rephrasing feature for this answer.

rephrasingMemoryinteger ยท int32Optional

The ammount of previous user inputs used to modify the rephrasing feature.

rephrasingBlackliststringOptional

A number os space-separated blacklisted words to evoid during rephrasing.

validAuthTypebooleanOptional
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
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 757

{
  "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,
  "isMasked": true,
  "headers": {},
  "type": "text",
  "executionLimit": 1,
  "rephraseEnabled": true,
  "rephrasingTemperature": 1,
  "rephrasingMemory": 1,
  "rephrasingBlacklist": "text",
  "transactionalAuth": {
    "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "validAuthType": true
}
{
  "answer": {
    "id": "text",
    "name": "text",
    "description": "text",
    "evaluable": 1,
    "transactional": 1,
    "isMasked": true,
    "updatedAt": "2025-05-11T11:37:39.548Z",
    "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",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ],
    "executionLimit": 1,
    "rephraseEnabled": true,
    "rephrasingTemperature": 1,
    "rephrasingMemory": 1,
    "rephrasingBlacklist": "text",
    "user": {
      "name": "text",
      "imageUrl": "text"
    },
    "transactionalAuth": {
      "authType": "AuthTypeEnum.AUTH_NONE(value=AUTH_NONE)",
      "basicToken": "text",
      "bearerToken": "text",
      "oauthUrl": "text",
      "grantType": "GrantTypeEnum.CLIENT_CREDENTIALS(value=CLIENT_CREDENTIALS)",
      "clientId": "text",
      "clientSecret": "text",
      "authUsername": "text",
      "authPassword": "text"
    }
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}
  • Pagination and Listing
  • GETSearches and paginates through expected answers -- those being of type 'TYPE_ANSWER' and 'WELCOME_MESSAGE'.
  • GETPaginates through not expected answers -- those being of type 'FIRST_CELL' and 'TYPE_ANYTHING_ELSE'.
  • GETSearches (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.
  • GETSearches (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.
  • GETSearches through all answers recently used on a given bot to start a flow.
  • CRUD Methods
  • POSTCreates a brand new answer
  • GETRetrieves info from a specific given answer.
  • PUTUpdates an answer.
  • DELETEDeletes an answer. The answer is disabled via the 'removed' parameter rather than deleted from the DB.

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

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

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

Deletes an answer. The answer is disabled via the 'removed' parameter 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

No content

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*
[
  "text"
]
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/not-expected/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*
[
  "text"
]
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",
        "translations": [
          {
            "answerTemplateUUID": "text",
            "locale": "text",
            "content": "text"
          }
        ]
      }
    ],
    "rephraseEnabled": true,
    "tags": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
]
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/{uuid} HTTP/1.1
Host: 
Accept: */*