CREATE

Create a new NLP category that will be associated with the customer API key

CREATE

POST https://api.eyelevel.ai/v1/partner/nlp/category/:apiKey

Path Parameters

Name	Type	Description
apiKey	string	EyeLevel customer key

Request Body

Name	Type	Description
nlp	object	See request definition below

200

{
    "nlp": {
        "category": {
            "categoryId": INTEGER IDENTIFIER,
            "name":       "STRING"
        }
    }
}

Request

{
    "nlp": {
        "connections": [
            { CONNECTION OBJECT }
        ],
        "id":   "STRING IDENTIFIER",
        "name": "STRING"
        "steps": [
            { STEP OBJECT }
        ],
    }
}

connections

OPTIONAL - Array of CONNECTION objects

An array of CONNECTION objects, containing information about how steps are connected to each other in the flow. If the flow contains more than one STEP, connections is a required parameter. Connections are described in greater detail here.

id

OPTIONAL - String

Validation: Value is an existing EyeLevel flow identifier

The unique identifier for the chat flow you want to associate with the NLP category. This chat flow will be used as the response for the NLP category.

name

REQUIRED - String

Validation: 80 character limit

The human readable name for the NLP category.

steps

OPTIONAL - Array of STEP objects

An array of STEP objects, containing information about each step in the flow. The definition of steps are described in greater detail here.

Response

{
    "nlp": {
        "category": {
            "categoryId": INTEGER IDENTIFIER,
            "name":       "STRING"
        }
    }
}

categoryId

The unique identifier for the NLP category.

Objects

pageCONNECTION

pageSTEP