Skip to main content
POST
/
v2.0
/
nluconnectors
Create an NLU Connector
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/nluconnectors \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "projectId": "<string>"
}
'
{
  "name": "New NLUConnector",
  "type": "cognigy",
  "settings": {
    "invocationName": "<string>",
    "reparseAlexaSlots": true,
    "skill": {
      "lastUpdated": "<string>",
      "nameByLocale": {
        "en-US": "<string>",
        "de-DE": "<string>",
        "ja-JP": "<string>",
        "en-GB": "<string>",
        "en-IN": "<string>"
      },
      "skillId": "<string>",
      "stage": "<string>"
    }
  },
  "transformer": {
    "abortOnError": false,
    "transformerStackEnabled": false,
    "transformer": "<string>",
    "preNluTransformerEnabled": false,
    "postNluTransformerEnabled": false,
    "nluCodeTransformerEnabled": false
  },
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Query Parameters

​
resourceId
string

An Id of a resource within the corresponding project to copy from

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json
​
name
string

The name of the NLU Connector.

Example:

"New NLUConnector"

​
type
enum<string>

The NLU Connector type.

Available options:
alexa,
dialogflow,
dialogflowBuiltIn,
amazonLexBuiltIn,
luis,
watson,
noNlu,
cognigy,
code,
generativeAI,
lex
Example:

"cognigy"

​
settings
object

The settings used by the Alexa NLU Connector.

​
transformer
object
​
projectId
string

The unique identifier for the Project.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns NLUConnector metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
name
string

The name of the NLU Connector.

Example:

"New NLUConnector"

​
type
enum<string>

The NLU Connector type.

Available options:
alexa,
dialogflow,
dialogflowBuiltIn,
amazonLexBuiltIn,
luis,
watson,
noNlu,
cognigy,
code,
generativeAI,
lex
Example:

"cognigy"

​
settings
object

The settings used by the Alexa NLU Connector.

​
transformer
object
​
referenceId
string<uuid>
​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
lastChangedBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
Last modified on June 12, 2026