Chat

OpenAI-compliant chat completion operations.

Create chat completion

post

Stream a conversation turn using the OpenAI Chat Completion format. This endpoint translates the request into an NLX conversation turn and streams back the app's response.

Authorizations

BearerAuth

AuthorizationstringRequired

Standard OpenAI-style authentication. Your NLX API Key should be passed here.

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

modelstringRequired

Used to pass the session identifier. Expected format: "nlx:{conversationId}". If the conversationId is omitted (e.g., just "nlx"), a new UUID will be generated.

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

streambooleanOptional

If set, partial message deltas will be sent using Server-Sent Events. This API is optimized for streaming.

Default: true

Responses

200

Server-sent events stream. The response is streamed as a series of JSON objects prefixed with "data: ".

text/event-stream

Represents a streamed chunk of a chat completion response.

idstringOptional

A unique identifier for the chat completion.

objectstring · enumOptional

The object type, which is always "chat.completion.chunk".

Possible values:

createdintegerOptional

The Unix timestamp (in seconds) of when the chat completion was created.

modelstringOptional

The model (deployment key) used for the completion.

system_fingerprintstringOptional

A fingerprint representing the backend system state (process.env.TAG).

400

Bad Request

401

Unauthorized - Invalid Bearer Token

post

/{deploymentKey}/{channelKey}/chat/completions

HTTPcURLJavaScriptPython

POST /v1/{deploymentKey}/{channelKey}/chat/completions HTTP/1.1
Host: apps.nlx.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "model": "nlx:550e8400-e29b-41d4-a716-446655440000",
  "messages": [
    {
      "role": "system",
      "content": "text"
    }
  ],
  "stream": true
}

{
  "id": "text",
  "object": "chat.completion.chunk",
  "created": 1,
  "model": "text",
  "system_fingerprint": "text",
  "choices": [
    {
      "index": 1,
      "delta": {
        "role": "system",
        "content": "text"
      },
      "logprobs": {},
      "finish_reason": "stop"
    }
  ]
}