Introduction
Project Integration APIs — project-level access for conversations, voice calls, and knowledgebase search using an API Key.
Project Integration APIs provide simple, project-level access for the most common integration use cases — building custom chat interfaces, triggering outbound calls, and querying your knowledgebase. Use an API Key (apk-...) created inside your project's integration settings.
Project Integration APIs are available on Professional plan and above.
Base URL: https://api.yourgpt.ai/chatbot/v1
Quick start
Create a session
curl -X POST https://api.yourgpt.ai/chatbot/v1/createSession \
-H "Content-Type: application/json" \
-H "api-key: apk-your-api-key" \
-d '{"widget_uid": "your-widget-uid"}'{
"type": "RXSUCCESS",
"message": "Chatbot session created successfully",
"data": {
"session_uid": "17226012685401506",
"state": "pending",
"status": "open"
}
}Send a message
You must first create a session to get a session_uid before sending messages.
curl -X POST https://api.yourgpt.ai/chatbot/v1/sendMessage \
-H "Content-Type: application/json" \
-H "api-key: apk-your-api-key" \
-d '{"widget_uid": "your-widget-uid", "session_uid": "your-session-uid", "message": "Hello"}'{
"type": "RXSUCCESS",
"message": "AI reply",
"data": {
"send_by": "assistant",
"message": "Hello! How can I assist you today?"
}
}