Conversation

Operations related to processing conversation turns.

Process a conversation turn

post

Main endpoint for conversational applications. Sends a user request to the specific AI app deployment and channel.

Authorizations

ApiKeyAuth

nlx-api-keystringRequired

Path parameters

deploymentKeystringRequired

The unique key identifying the AI app deployment.

channelKeystringRequired

The unique key identifying the specific channel. Must include the language code suffix (e.g., -en-US, -es-MX).

Example: xxxxxxxx-en-US

Body

application/json

conversationIdstring | nullableOptional

Unique identifier for the conversation session. Auto-generated if omitted.

userIdstringOptional

Unique identifier for the user. Auto-generated if omitted.

streambooleanOptional

Enables Streamable HTTP

Default: true

Responses

200

Successful conversation response

application/jsontext/event-stream

400

Bad Request - Invalid schema or missing required fields

401

Unauthorized - Invalid API Key

500

Internal Server Error

post

/c/{deploymentKey}/{channelKey}

HTTPcURLJavaScriptPython

POST /c/{deploymentKey}/{channelKey} HTTP/1.1
Host: apps.nlx.ai
nlx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "request": {
    "unstructured": {
      "text": "text"
    },
    "structured": {
      "intentId": "text",
      "slots": [
        {
          "slotId": "text",
          "value": "text",
          "topValues": [
            "text"
          ],
          "choicePayload": "text"
        }
      ],
      "choiceId": "text",
      "uploadIds": [
        "text"
      ],
      "utterance": "text"
    }
  },
  "conversationId": "text",
  "userId": "text",
  "context": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "stream": true
}

{
  "messages": [
    {
      "messageId": "text",
      "text": "text",
      "type": "text",
      "choices": [
        {
          "choiceId": "text",
          "choiceText": "text"
        }
      ],
      "choicesMetadata": {
        "source": "Local"
      },
      "metadata": {
        "sources": [
          {
            "fileName": "text",
            "pageNumber": 1,
            "content": "text",
            "presignedUrl": "text",
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      }
    }
  ],
  "conversationId": "text",
  "expirationTimestamp": "2025-11-27T06:47:14.268Z",
  "modalities": [
    "text"
  ],
  "payload": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "multimodalEnabled": true,
    "hasPendingDataRequest": true,
    "intentId": "text",
    "escalation": true,
    "frustration": true,
    "incomprehension": true,
    "uploadUrls": [
      "text"
    ],
    "isGenerative": true,
    "feedbackUrl": "text",
    "escalationChannel": {}
  },
  "context": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}