## Documentation Index Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt) Use this file to discover all available pages before exploring further. GET / v2.0 /nluconnectors ### Try it #### Get NLU Connectors **cURL** ```bash curl --request GET \ --url https://api-trial.cognigy.ai/new/v2.0/nluconnectors \ --header 'X-API-Key: ' ``` ```python import requests url = "https://api-trial.cognigy.ai/new/v2.0/nluconnectors" headers = {"X-API-Key": ""} response = requests.get(url, headers=headers) print(response.text) ``` ```javascript const options = {method: 'GET', headers: {'X-API-Key': ''}}; fetch('https://api-trial.cognigy.ai/new/v2.0/nluconnectors', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ```php "https://api-trial.cognigy.ai/new/v2.0/nluconnectors", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "X-API-Key: " ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ?> ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-trial.cognigy.ai/new/v2.0/nluconnectors" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-API-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ```java HttpResponse response = Unirest.get("https://api-trial.cognigy.ai/new/v2.0/nluconnectors") .header("X-API-Key", "") .asString(); ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-trial.cognigy.ai/new/v2.0/nluconnectors") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-API-Key"] = '' response = http.request(request) puts response.read_body ``` ### Response Codes - 200 - 400 - 401 - 402 - 403 - 404 - 405 - 409 - 413 - 500 - 501 - 502 - 503 - 504 ```json { "items": [ { "name": "New NLUConnector", "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "type": "cognigy", "_id": "", "createdAt": 1694518620, "lastChanged": 1694518620, "createdBy": "", "lastChangedBy": "" } ], "total": 1, "nextCursor": "", "previousCursor": "" } ``` ```json { "type": "Bad Request", "title": "Bad Request Error", "status": 400, "detail": "Validation failed. Missing payload.", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Unauthorized", "title": "Unauthorized Error", "status": 401, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 401, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Payment Required", "title": "Payment Required Error", "status": 402, "detail": "Validation failed. Missing payload.", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 402, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Forbidden", "title": "Forbidden Error", "status": 403, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Not Found", "title": "Not Found Error", "status": 404, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {}, "logLevel": "error" } ``` ```json { "type": "Method Not Allowed", "title": "Method Not Allowed Error", "status": 405, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Conflict", "title": "Conflict Error", "status": 409, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1004, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Payload Too Large", "title": "Payload Too Large Error", "status": 413, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Internal Server Error", "title": "Internal Server Error", "status": 500, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Not Implemented", "title": "Not Implemented Error", "status": 501, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1009, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Bad Gateway", "title": "Bad Gateway Error", "status": 502, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Service Unavailable", "title": "Service Unavailable Error", "status": 503, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 503, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ```json { "type": "Gateway Timeout", "title": "Gateway Timeout Error", "status": 504, "detail": "", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} } ``` ### Authorizations **APIKeyHeader** - APIKeyQueryParam - CXoneTokenHeader - OAuth2APIKeyHeader #### X-API-Key - Type: string - In: header - Required: Supply the API Key in the HTTP-Header ### Headers #### Accept - Type: enum - 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 - `projectId` (string): The unique identifier for the Project. Required string length: `24`. Pattern: `^[a-z0-9]{24}$` - `filter` (string): The name of the NLU Connector to filter the records. - `limit` (integer): The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100. Required range: `1 <= x <= 100` - `skip` (integer): The number of items to skip before returning the results. Use this parameter with `limit` for offset-based pagination. The default value is 0. Required range: `x >= 0` - `sort` (string): The order in which results are returned. Set a sorting rule in the format `field:direction`, where direction can be `asc` for ascending order or `desc` for descending order. Minimum string length: `1` - `next` (string): The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items. Required string length: `24` - `previous` (string): The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items. Required string length: `24` ### Response - **200**: application/json - Returns an array of a NLUConnector metadata objects #### items - Type: object[] #### total - Type: integer - Example: `1` #### nextCursor - Type: string | null - Required string length: `24` - Pattern: `^[a-z0-9]{24}$` #### previousCursor - Type: string | null - Required string length: `24` - Pattern: `^[a-z0-9]{24}$`