Track API

Operations for tracking multimodal Voice+ journeys.

Track Voice+ step

post

Track user progress through Voice+ multimodal journeys by sending step transitions. Used to coordinate state between voice interactions and visual interfaces.

Authorizations

VoicePlusAuth

x-api-keystringRequired

Requires two headers: x-api-key (Voice+ API Key) and x-nlx-id (Workspace ID). Note: OpenAPI 3.0 limitations only allow defining one key name per scheme efficiently, so assume both are required as per documentation.

Body

application/json

stepIdstring · uuidRequired

UUID v4 identifier for the step being tracked.

Example: 550e8400-e29b-41d4-a716-446655440000

conversationIdstringRequired

Unique identifier for the Voice+ conversation session.

Example: conv_voice_abc123

journeyIdstring · uuidRequired

UUID identifier for the Voice+ journey/script being executed.

Example: journey_uuid_def456

languageCodestringRequired

Language code for the Voice+ experience (format 'xx-XX').

Example: en-US

stepTriggerDescriptionstring · max: 500Optional

Optional human-readable description of what triggered this step.

Responses

200

Step successfully tracked

application/json

400

Bad Request - Invalid step data or format

401

Unauthorized - Invalid Voice+ credentials

403

Forbidden - Access denied to journey/script

429

Too Many Requests

post

/track

HTTPcURLJavaScriptPython

POST /v1/track HTTP/1.1
Host: mm.nlx.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "stepId": "550e8400-e29b-41d4-a716-446655440000",
  "conversationId": "conv_voice_abc123",
  "journeyId": "journey_uuid_def456",
  "languageCode": "en-US",
  "context": {
    "selectedSeat": "4A"
  },
  "stepTriggerDescription": "text"
}

{
  "success": true,
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2025-11-27T07:00:20.429Z",
  "conversationId": "text",
  "journeyId": "text"
}