Chat

Chat with a chatbot

Changed on

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

post/chat

Request

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-oss-120b' | 'gpt-oss-20b' | 'gpt-5.2' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-6-luna' | 'gpt-6.1-sol' | 'gpt-6.1-terra' | 'claude-opus-5-5' | 'claude-sonnet-5-5' | 'claude-haiku-5-5' | 'gemini-2.5-pro' | 'gemini-3-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.1-pro' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.8-flash' | 'grok-4.7' | 'DeepSeek-V3.1' | 'DeepSeek-R1' | 'DeepSeek-V4-Flash' | 'DeepSeek-V4.1-Flash' | 'kimi-k2.6' | 'mistral-medium-3.5' | 'mistral-small-2603' | 'glm-5.2' | 'glm-5.3-flash' | 'auto'

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-6-luna",
  "temperature": 0.7
}

Response

Chat response

textstring

The chatbot's response text

Example response

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

Changes

    • breaking

      removed the enum value gpt-4o-mini of the request property

    • info

      added the new gpt-6.1-terra enum value to the request property

    • breaking

      removed the enum value DeepSeek-V3 of the request property

    • breaking

      removed the enum value Llama-4-Maverick-17B-128E-Instruct-FP8 of the request property

    • breaking

      removed the enum value Llama-4-Scout-17B-16E-Instruct of the request property

    • breaking

      removed the enum value claude-haiku-4-5 of the request property

    • breaking

      removed the enum value claude-opus-4-5 of the request property

    • breaking

      removed the enum value claude-opus-4-6 of the request property

    • breaking

      removed the enum value claude-opus-4-7 of the request property

    • breaking

      removed the enum value claude-opus-4-8 of the request property

    • breaking

      removed the enum value claude-sonnet-4-5 of the request property

    • breaking

      removed the enum value claude-sonnet-4-6 of the request property

    • breaking

      removed the enum value gemini-3.5-flash of the request property

    • breaking

      removed the enum value gpt-5-mini of the request property

    • breaking

      removed the enum value gpt-5-nano of the request property

    • breaking

      removed the enum value gpt-5.6-luna of the request property

    • breaking

      removed the enum value grok-3 of the request property

    • breaking

      removed the enum value grok-3-mini of the request property

    • breaking

      removed the enum value grok-4 of the request property

    • breaking

      removed the enum value kimi-k2 of the request property

    • info

      added the new DeepSeek-V3.1 enum value to the request property

    • info

      added the new DeepSeek-V4.1-Flash enum value to the request property

    • info

      added the new claude-haiku-5-5 enum value to the request property

    • info

      added the new claude-opus-5-5 enum value to the request property

    • info

      added the new claude-sonnet-5-5 enum value to the request property

    • info

      added the new gemini-3.8-flash enum value to the request property

    • info

      added the new glm-5.3-flash enum value to the request property

    • info

      added the new gpt-6-luna enum value to the request property

    • info

      added the new gpt-6.1-sol enum value to the request property

    • info

      added the new grok-4.7 enum value to the request property

    • info

      added the new kimi-k2.6 enum value to the request property