Getting Started

Before you can make requests to the GLChat API, you must obtain API Key. You can obtain them by contacting us via hi[at]glair.ai or via our representative for your company.

View full project code on GitHub

GLChat SDK

You can send message programmatically using GLChat SDK.

Install

pip install glchat-sdk

Set API Key

export GLCHAT_API_KEY=...

Make your first API call

from glchat_sdk import GLChat

client = GLChat()
response = client.message.create(
    chatbot_id="no-op",
    message="Hello!",
    stream=False
)

print(response.message)

This is a sample of the response:

Hello! How can I assist you today?

More details on PyPI glchat-sdk.

Install

npm install glchat-sdk

Set API Key

export GLCHAT_API_KEY=...

Make your first API call

import { GLChat } from "glchat-sdk";

const client = new GLChat();

void (async () => {
  const result = await client.message.create({
    chatbot_id: "no-op",
    message: "Hello!",
    stream: false
  });

  for await (const chunk of result) {
    console.log(chunk);
  }
})();

The response will be a streaming Server-Sent Event (SSE) so you can display parts of the response as they become available. This is a sample of the streaming response:

data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502862, "status": "response", "message": "Hello"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502873, "status": "response", "message": "Hello!"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502884, "status": "response", "message": "Hello! How"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502894, "status": "response", "message": "Hello! How can"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502913, "status": "response", "message": "Hello! How can I"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502924, "status": "response", "message": "Hello! How can I assist"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502969, "status": "response", "message": "Hello! How can I assist you"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502980, "status": "response", "message": "Hello! How can I assist you today"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502991, "status": "response", "message": "Hello! How can I assist you today?"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403503002, "status": "response", "message": "Hello! How can I assist you today?\n"}

More details on NPM glchat-sdk.

curl -X POST 'https://chat.gdplabs.id/api/proxy/message' \
-H 'Authorization: Bearer '$GLCHAT_API_KEY'' \
-F 'chatbot_id=no-op' \
-F 'message=Hello!'

The response will be a streaming Server-Sent Event (SSE) so you can display parts of the response as they become available. This is a sample of the streaming response:

data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502862, "status": "response", "message": "Hello"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502873, "status": "response", "message": "Hello!"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502884, "status": "response", "message": "Hello! How"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502894, "status": "response", "message": "Hello! How can"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502913, "status": "response", "message": "Hello! How can I"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502924, "status": "response", "message": "Hello! How can I assist"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502969, "status": "response", "message": "Hello! How can I assist you"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502980, "status": "response", "message": "Hello! How can I assist you today"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403502991, "status": "response", "message": "Hello! How can I assist you today?"}
data:{"conversation_id": null, "user_message_id": null, "assistant_message_id": null, "created_date": 1750403503002, "status": "response", "message": "Hello! How can I assist you today?\n"}

For more advanced usages, see How-To Guides.

Notes for On-Premises GL Chat

If you use self-managed on-premises GL Chat, you can set API Keys via environment variable:

# Available API Keys
PROXY_API_KEYS=api-key-1,api-key-2

# What endpoints can user access via API (in this examples, user can only access /message)
PROXY_ENDPOINTS=message

# What endpoints can user access via API (in this examples, user can access /message and /conversations)
PROXY_ENDPOINTS=message,conversations

See GLChat UI for more details on environment variables.

PreviousFeatures NextHow-To Guides

Last updated 25 days ago

hashtagGLChat SDK

hashtagNotes for On-Premises GL Chat

GLChat SDK

Notes for On-Premises GL Chat