Skip to main content
GET
/
init_conversation
Initialize Conversation
curl --request GET \
  --url https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/init_conversation
{
  "data": {
    "valid": true,
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "introductory_message": {
      "switch": true,
      "buttons": [
        "<string>"
      ],
      "content": "Hello! 👋"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chatzy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a conversation_id for the session and verifies the chatbot_id provided. chatbot_id -> Get this from Conversational AI Agents > open your agent’s menu (⋮ / hamburger) > Copy Agent ID. This also returns introductory message if the chatbot is configured to do so. You can configure introductory messages in the Chat Widget tab of the AI Agent Settings page. Chat Widget Tab This will be visible like this at the beginning of the conversation: Iframe

Query Parameters

​
chatbot_id
string<uuid>
required

UUID of the chatbot to initiate conversation with.

Response

200 - application/json

Conversation initialized successfully.

​
data
object