GET

Query an existing NLP setting by flow ID

QUERY

GET https://api.eyelevel.ai/v1/partner/nlp/setting/:apiKey/:settingId

Path Parameters

Name	Type	Description
apiKey	string	EyeLevel customer key
settingId	integer	NLP setting identifier

200

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

Response

{
    "nlp": {
        "setting": {
            "categoryIds": [
                INTEGER IDENTIFIER
            ],
            "name":      STRING,
            "settingId": INTEGER IDENTIFIER
        }
    }
}

categoryIds

An array of unique identifiers for NLP categories associated with the NLP setting.

name

The human readable name of the NLP setting.

settingId

The unique identifier for the NLP setting.