Context

Operations for asynchronously setting context for active NLX conversations.

Set conversation context

post

Send contextual information for active conversations, especially Voice+. Provides structured context about web page elements, form fields, and available actions to the active voice session.

Authorizations

ApiKeyAuth

nlx-api-keystringRequired

Standard authentication for Conversation endpoints.

Path parameters

deploymentKeystringRequired

The unique key identifying the NLX app deployment.

channelKeystringRequired

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

Example: xxxxxxxxxx-en-US

Body

application/json

conversationIdstringRequired

The conversation ID for this session.

Responses

200

Context successfully received and processed.

application/json

objectOptional

400

Bad Request - Invalid context format.

403

Forbidden - Invalid API key or unauthorized context submission.

post

/c/{deploymentKey}/{channelKey}/context

HTTPcURLJavaScriptPython

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

{
  "conversationId": "text",
  "context": {
    "nlx:vpContext": {
      "uri": "text",
      "actions": [
        {
          "action": "text",
          "description": "text",
          "input": {},
          "schema": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "fields": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "description": "text",
          "placeholder": "text",
          "value": null,
          "options": [
            {
              "value": null,
              "text": null,
              "selected": true
            }
          ]
        }
      ],
      "destinations": [
        "text"
      ],
      "scopes": [
        "text"
      ]
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{}