> ## Documentation Index > Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an NLU Connector > Gets information about an NLU Connector in a Project. ## OpenAPI ````yaml https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/nluconnectors/{nluConnectorId} openapi: 3.0.0 info: title: Cognigy.AI REST-ful-API Reference version: 2026.10.1 description: > ### Introduction This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation of the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful Cognigy.AI API. ### Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows cross-domain communication from the browser. All responses include a wildcard same-origin header, making the API fully accessible. ### Authentication Cognigy.AI offers four forms of authentication: - API Key - CXone Token - OAuth2 - BasicAuth An API Key is a security token. You can use API Keys in your path or HTTP header. Never expose your API Key and keep it safe and secure. Revoke the API Key if it got exposed or stolen. OAuth2 is an open protocol to allow secure authorization by web, mobile and desktop applications. For further information see [RFC 6749 - "The OAuth 2.0 Authorization Framework"](https://tools.ietf.org/html/rfc6749) and [RFC 6750 - "The OAuth 2.0 Authorization Framework: Bearer Token Usage"](https://tools.ietf.org/html/rfc6750). Basic Auth is only used for API calls regarding the Management-UI. ### Error Handling This API uses HTTP status codes equal or above 400 to indicate errors. Error details are generated in compliance with [RFC 7807 - "Problem Details for HTTP APIs"](https://tools.ietf.org/html/rfc7807). Every error response contains a traceId, which should be provided to the Cognigy.AI Technical Support when reporting an error. contact: name: Cognigy Technical Support url: https://www.cognigy.com email: support@cognigy.com servers: - url: https://api-trial.cognigy.ai/new/ description: Cognigy.AI API security: - APIKeyHeader: [] - APIKeyQueryParam: [] - CXoneTokenHeader: [] - OAuth2: [] - BasicAuth: [] tags: - name: Cognigy.AI REST-ful API description: The Cognigy.AI REST-ful API externalDocs: description: Cognigy.AI Documentation url: https://docs.cognigy.com/docs/ paths: /v2.0/nluconnectors/{nluConnectorId}: get: tags: - NLU Connectors summary: Get an NLU Connector description: Gets information about an NLU Connector in a Project. operationId: readNLUConnector_2_0 parameters: - in: header name: Accept description: >- 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`. required: false schema: type: string enum: - application/json - application/hal+json - application/xml - text/xml - text/csv example: application/json - in: path name: nluConnectorId description: The unique identifier for the NLU Connector. required: true schema: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 responses: '200': description: Returns NLUConnector Object content: application/json: schema: type: object properties: name: type: string description: The name of the NLU Connector. example: New NLUConnector type: type: string description: The NLU Connector type. example: cognigy enum: - alexa - dialogflow - dialogflowBuiltIn - amazonLexBuiltIn - luis - watson - noNlu - cognigy - code - generativeAI - lex settings: oneOf: - type: object description: The settings used by the Alexa NLU Connector. properties: invocationName: type: string description: >- The invocation name of the Alexa skill. Necessary to start Alexa simulations. reparseAlexaSlots: type: boolean description: >- If set to `true`, reparses slots from Alexa with the Keyphrase mapper. skill: type: object properties: lastUpdated: type: string description: When the skill was last updated. nameByLocale: type: object description: The name of the skill for different locales. properties: en-US: type: string de-DE: type: string ja-JP: type: string en-GB: type: string en-IN: type: string skillId: type: string description: The unique ID of the skill. stage: type: string description: >- The current stage of the skill life cycle, for example, development, production. - type: object description: The settings used by the DialogFlow NLU Connector. properties: dialogflowApiVersion: type: integer description: The version of the dialogflow API to use. enum: - 1 - 2 dialogflowProjectId: type: string description: The projectId of the Dialogflow Agent. accessToken: description: >- The access token used to authenticate requests. Used by DialogFlow. type: string privateKey: type: string description: >- The private key of a Google Service Account that has access rights to use the Dialogflow API. - type: object description: The settings used by the LUIS NLU Connector. properties: authenticationURL: type: string description: The URL used to authenticate requests by LUIS. - type: object description: The settings used by the Watson NLU Connector. properties: apikey: type: string description: The API key for accessing the Watson NLU API. workspaceid: type: string description: The skill ID for accessing the Assistant skill. serviceURL: type: string description: The URL used to authenticate requests by Watson. - type: object description: The settings used by the Lex NLU Connector. properties: accessKeyId: type: string description: The API key for accessing the Lex NLU API. secretAccessKey: type: string description: >- The secret access key for accessing the Lex NLU API. awsRegion: type: string description: The AWS region the Lex bot is deployed to. botId: type: string description: The ID of the Lex bot. botAliasId: type: string description: The alias ID of the Lex bot. transformer: type: object properties: abortOnError: type: boolean description: >- If set to `true`, cancels message processing if the transformer throws an error. If set to `false`, processing continues. The default value is `false`. example: false transformerStackEnabled: type: boolean description: >- If set to `true`, writes the transformer data to the Input object in the Interaction Panel. The default value is `false`. example: false transformer: type: string description: >- The transformer's JavaScript source code. If the parameter is empty, a code template specific to the NLU Connector type is used. preNluTransformerEnabled: type: boolean description: >- If set to `true`, runs the pre-NLU transformer when a message arrives. The transformer receives the incoming text and data, and can modify them before the NLU engine runs. Only relevant for external NLU. The default value is `false`. example: false postNluTransformerEnabled: type: boolean description: >- If set to `true`, runs the post-NLU transformer after the NLU engine has produced a result. The transformer receives the NLU engine result, text and data, and can modify them before the Flow is executed. The default value is `false`. example: false nluCodeTransformerEnabled: type: boolean description: >- If set to `true`, runs the code in the transformer editor in the NLU Connector settings on each message. Only relevant for Code and Cognigy NLU Connector types. The default value is `false`. example: false referenceId: type: string format: uuid _id: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 createdAt: type: integer description: Unix-timestamp example: 1694518620 minimum: 0 maximum: 2147483647 lastChanged: type: integer description: Unix-timestamp example: 1694518620 minimum: 0 maximum: 2147483647 createdBy: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 lastChangedBy: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 description: > 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. '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing) content: application/json: schema: type: object properties: type: type: string example: Bad Request title: type: string example: Bad Request Error status: type: number example: 400 detail: type: string example: Validation failed. Missing payload. instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '401': description: >- The request has not been applied because it lacks valid authentication credentials for the target resource. content: application/json: schema: type: object properties: type: type: string example: Unauthorized title: type: string example: Unauthorized Error status: type: number example: 401 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 401 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '402': description: Upgrade your Plan to increase your Quota. content: application/json: schema: type: object properties: type: type: string example: Payment Required title: type: string example: Payment Required Error status: type: number example: 402 detail: type: string example: Validation failed. Missing payload. instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 402 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '403': description: The server understood the request but refuses to authorize it. content: application/json: schema: type: object properties: type: type: string example: Forbidden title: type: string example: Forbidden Error status: type: number example: 403 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '404': description: >- The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. content: application/json: schema: type: object properties: type: type: string example: Not Found title: type: string example: Not Found Error status: type: number example: 404 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} logLevel: type: string example: error '405': description: >- The method received in the request-line is known by the origin server but not supported by the target resource. content: application/json: schema: type: object properties: type: type: string example: Method Not Allowed title: type: string example: Method Not Allowed Error status: type: number example: 405 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '409': description: The request conflicts with current state of the server. content: application/json: schema: type: object properties: type: type: string example: Conflict title: type: string example: Conflict Error status: type: number example: 409 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1004 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '413': description: The request entity is larger than limits defined by server. content: application/json: schema: type: object properties: type: type: string example: Payload Too Large title: type: string example: Payload Too Large Error status: type: number example: 413 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '500': description: >- The server encountered an unexpected condition that prevented it from fulfilling the request. content: application/json: schema: type: object properties: type: type: string example: Internal Server Error title: type: string example: Internal Server Error status: type: number example: 500 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '501': description: >- The server does not support the functionality required to fulfill the request. content: application/json: schema: type: object properties: type: type: string example: Not Implemented title: type: string example: Not Implemented Error status: type: number example: 501 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1009 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '502': description: >- The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. content: application/json: schema: type: object properties: type: type: string example: Bad Gateway title: type: string example: Bad Gateway Error status: type: number example: 502 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '503': description: The server is not ready to handle the request. content: application/json: schema: type: object properties: type: type: string example: Service Unavailable title: type: string example: Service Unavailable Error status: type: number example: 503 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 503 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '504': description: >- The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. content: application/json: schema: type: object properties: type: type: string example: Gateway Timeout title: type: string example: Gateway Timeout Error status: type: number example: 504 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} security: - APIKeyHeader: [] - APIKeyQueryParam: [] - CXoneTokenHeader: [] - OAuth2: [] components: securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key description: Supply the API Key in the HTTP-Header APIKeyQueryParam: type: apiKey in: query name: api_key description: Supply the API Key in the Url-Query CXoneTokenHeader: type: apiKey in: header name: x-cxone-authorization description: >- Supply the CXone Token in the HTTP-Header containing the word "Bearer" followed by a space and a Token String. Applicable only in CXone integrated environments. OAuth2: type: oauth2 flows: password: tokenUrl: /auth/oauth2/token refreshUrl: /auth/oauth2/token scopes: {} authorizationCode: authorizationUrl: /auth/oauth2/authorize tokenUrl: /auth/oauth2/token scopes: {} BasicAuth: type: http scheme: basic description: Basic Authentication used by routes designed for the Management-UI. ````