GPT Chatbot API Documentation
This is the complete API documentation for connecting to the GPT Chatbot API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet GPT Chatbot: Build, manage, and interact with GPT Chatbot bots, agents, sessions, messages, and data sources. Keep reading to get started.
Quickstart
Before you run your first GPT Chatbot request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one GPT Chatbot connection — create or choose one in Connections. Note its
connectionId.
Every GPT Chatbot action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/gPTChatbot/actions/{actionSlug}/runYou need a MindCloud API Key and a GPT Chatbot connection. Then call an action such as List Chatbots:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/gPTChatbot/actions/list-chatbots/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your GPT Chatbot account. See GPT Chatbot API Authentication for the full flow and how to get your connection credentials.
GPT Chatbot actions
All 24 published actions for this GPT Chatbot version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Agent
- POSTCreate Chatbot
- POSTCreate Message
- POSTCreate QA Source
- POSTCreate Session
- POSTCreate URL Source
- DELETEDelete Agent
- DELETEDelete Chatbot
- DELETEDelete Message
- DELETEDelete Session
- DELETEDelete Source
- GETGet Chatbot
- GETGet Session
- GETGet Session History
- GETList Agents
- GETList Chatbots
- GETList Messages
- GETList Sessions
- GETList Sources
- PUTRetrain Sources
- PUTUpdate Agent
- PUTUpdate Chatbot
- PUTUpdate Source
- POSTUpload File
Related apps
More Artificial Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.