Get YesNoIntents - Cognigy Documentation

GET

v2.0

locales

{localeId}

yesnointents

Get YesNoIntents

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "yesIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "noIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "rejectIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  }
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

api_key

string

query

required

Supply the API Key in the Url-Query

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

localeId

string

required

The Id of the Locale

Required string length: 24

Response

Returns an object containing the yesIntent, noIntent, rejectIntent for the given locale

yesIntent

object

Show child attributes

yesIntent.isDisabled

boolean

yesIntent.name

string

Example:

"pizza"

yesIntent._id

string

Required string length: 24

yesIntent.rules

string[]

noIntent

object

Show child attributes

noIntent.isDisabled

boolean

noIntent.name

string

Example:

"pizza"

noIntent._id

string

Required string length: 24

noIntent.rules

string[]

rejectIntent

object

Show child attributes

rejectIntent.isDisabled

boolean

rejectIntent.name

string

Example:

"pizza"

rejectIntent._id

string

Required string length: 24

rejectIntent.rules

string[]

Delete an YesNoIntentDelete an [Intent](doc:endpoint), once deleted you will not have an option of creating it, you will need a new locale to have the yesNoIntents.

⌘I

Get YesNoIntents

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/locales/{localeId}/yesnointents?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "yesIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "noIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  },
  "rejectIntent": {
    "isDisabled": true,
    "name": "pizza",
    "_id": "<string>",
    "rules": [
      "<string>"
    ]
  }
}

Overview

API

Authorizations

Path Parameters

Response