Sign in

v1

latestOpenAPI 3.0.32026-07-13201451.3 KB
Chat

Chat with a chatbot

Send a message to a chatbot and receive a response. Supports streaming responses. Can continue existing conversations by providing a conversationId.

post/chat

Request body

chatbotIdstring required

ID of the chatbot to chat with

conversationIdstring

ID of existing conversation to continue, if not provided, the conversation will not be saved

contactIdstring

External ID of the contact/user

model'gpt-4o' | 'gpt-4o-mini' | 'o4-mini' | 'gpt-oss-120b' | 'gpt-oss-20b' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-opus-4-6' | 'claude-sonnet-4-6' | 'claude-opus-4-5' | 'claude-haiku-4-5' | 'claude-sonnet-4-5' | 'gemini-2.5-flash' | 'gemini-2.5-pro' | 'gemini-3-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.1-pro' | 'grok-3' | 'grok-3-mini' | 'grok-4' | 'DeepSeek-V3' | 'DeepSeek-R1' | 'Llama-4-Scout-17B-16E-Instruct' | 'Llama-4-Maverick-17B-128E-Instruct-FP8' | 'kimi-k2'

AI model to use for the response

temperaturenumber

Temperature setting for AI response creativity

streamboolean

Whether to stream the response

Example request

{
  "chatbotId": "ckl123abc456",
  "messages": [
    {
      "role": "user",
      "content": "Hello, I need help with my order"
    }
  ],
  "conversationId": "conv_abc123",
  "contactId": "user_123",
  "model": "gpt-4o-mini",
  "temperature": 0.7
}

Response

Chat response

textstring

The chatbot's response text

Example response

{
  "text": "Hello! How can I help you today?"
}
All 20 operations