12 available actions
What your AI agent can do in GPTBots
GPTBots is an enterprise AI agent platform for conversations, knowledge management, databases, user data, and usage analytics. This toolkit auth config supports Singapore Agent API Keys only; JP and TH keys are unsupported because requests use the fixed Singapore base URL. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 12 actions.
Common starting points
- Get Agent InformationReturn the GPTBots Agent bound to the connected Agent API Key, including its ID and runtime configuration.
- Get Total Credit ConsumptionReturn aggregate Agent credit consumption by category for a reporting range of up to 365 days.
- Send MessageSend the latest user text to a GPTBots conversation and wait for the Agent's complete blocking response.
- Create ConversationCreate a GPTBots conversation for a developer-defined user on the Agent connected by this API key.
Browse all 12 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 10 actions
- Get Agent InformationReturn the GPTBots Agent bound to the connected Agent API Key, including its ID and runtime configuration.
- Get Total Credit ConsumptionReturn aggregate Agent credit consumption by category for a reporting range of up to 365 days.
- List Conversation CreditsReturn one page of per-conversation Agent credit consumption for a time range of up to 30 days, optionally filtered by conversation ID.
- List Conversation MessagesReturn one page of current v2 message details for a GPTBots conversation.
- List ConversationsReturn one page of Agent conversations filtered by source, recent-chat time range, and optional user.
- List Database TablesReturn database tables configured for the Agent ID supplied by the caller.
- List Knowledge BasesReturn all knowledge bases attached to the GPTBots Agent connected by this API key.
- List Knowledge DocumentsReturn one page of documents in a GPTBots knowledge base.
- List Metadata FieldsReturn global and per-knowledge-base document metadata field definitions for the connected GPTBots Agent.
- Query User AttributesReturn configured GPTBots Agent attributes for either developer user IDs or anonymous IDs.
Create & communicateCreate records or send supported messagesView 2 actions
- Create ConversationCreate a GPTBots conversation for a developer-defined user on the Agent connected by this API key.
- Send MessageSend the latest user text to a GPTBots conversation and wait for the Agent's complete blocking response.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect GPTBots
How does the agent connect to GPTBots?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in GPTBots?
The page above lists the 12 actions currently available through the GPTBots connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is GPTBots included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until GPTBots is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put GPTBots to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.