> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

![GPTBots logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/gptbots.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=5f0150e1fb3e8294ca4bda7ea40788f2)

* **Category:** ai agents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `GPTBOTS`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Conversation
>
> **Slug:** `GPTBOTS_CREATE_CONVERSATION`
>
> Create a GPTBots conversation for a developer-defined user on the Agent connected by this API key. Returns the conversation ID needed for subsequent message and history operations. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Developer-defined user ID used for conversation memory, user attributes, and analytics. Maximum 32 characters.
>
> **anonymous\_id** `string`
>
> Device or anonymous-user ID to bind to the conversation. Omit it to let GPTBots generate an anonymous ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent Information
>
> **Slug:** `GPTBOTS_GET_AGENT_INFORMATION`
>
> Return the GPTBots Agent bound to the connected Agent API Key, including its ID and runtime configuration. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Total Credit Consumption
>
> **Slug:** `GPTBOTS_GET_TOTAL_CREDIT_CONSUMPTION`
>
> Return aggregate Agent credit consumption by category for a reporting range of up to 365 days. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **end\_time** `integer` *required*
>
> End of the reporting range as a Unix timestamp in milliseconds; must not precede start\_time or be more than 365 days after it.
>
> **start\_time** `integer` *required*
>
> Start of the reporting range as a Unix timestamp in milliseconds.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Conversation Credits
>
> **Slug:** `GPTBOTS_LIST_CONVERSATION_CREDITS`
>
> Return one page of per-conversation Agent credit consumption for a time range of up to 30 days, optionally filtered by conversation ID. GPTBots code 40001 means the time range is invalid and must be corrected, not retried. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **end\_time** `integer` *required*
>
> End of the reporting range as a Unix timestamp in milliseconds; must not precede start\_time or be more than 30 days later.
>
> **page\_size** `integer`
>
> Conversation usage records per page (1-100).
>
> **start\_time** `integer` *required*
>
> Start of the reporting range as a Unix timestamp in milliseconds.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **conversation\_id** `string`
>
> Conversation ID to filter by; omit to include all conversations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Conversation Messages
>
> **Slug:** `GPTBOTS_LIST_CONVERSATION_MESSAGES`
>
> Return one page of current v2 message details for a GPTBots conversation. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Messages to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **conversation\_id** `string` *required*
>
> Conversation whose message history to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Conversations
>
> **Slug:** `GPTBOTS_LIST_CONVERSATIONS`
>
> Return one page of Agent conversations filtered by source, recent-chat time range, and optional user. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Developer user ID to filter by; omit to include all users.
>
> **end\_time** `integer` *required*
>
> End of the recent-chat time range as a Unix timestamp in milliseconds; must not precede start\_time.
>
> **page\_size** `integer`
>
> Conversations per page (10-100).
>
> **start\_time** `integer` *required*
>
> Start of the recent-chat time range as a Unix timestamp in milliseconds.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
>
> **conversation\_type** `string`
>
> Conversation source filter, such as ALL, API, or EMBED.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Database Tables
>
> **Slug:** `GPTBOTS_LIST_DATABASE_TABLES`
>
> Return database tables configured for the Agent ID supplied by the caller. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Agent ID (bot\_id) returned by Get Agent Information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Knowledge Bases
>
> **Slug:** `GPTBOTS_LIST_KNOWLEDGE_BASES`
>
> Return all knowledge bases attached to the GPTBots Agent connected by this API key. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Knowledge Documents
>
> **Slug:** `GPTBOTS_LIST_KNOWLEDGE_DOCUMENTS`
>
> Return one page of documents in a GPTBots knowledge base. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Documents to return in this page (10-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **knowledge\_base\_id** `string` *required*
>
> Knowledge base ID, obtainable from List Knowledge Bases.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Metadata Fields
>
> **Slug:** `GPTBOTS_LIST_METADATA_FIELDS`
>
> Return global and per-knowledge-base document metadata field definitions for the connected GPTBots Agent. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query User Attributes
>
> **Slug:** `GPTBOTS_QUERY_USER_ATTRIBUTES`
>
> Return configured GPTBots Agent attributes for either developer user IDs or anonymous IDs. Exactly one non-empty selector is required. Missing identities are successful results with no property values. GPTBots documents a shared default limit of 3 requests per minute for Free Plan accounts; higher or custom tiers may differ. On Free Plan, serialize calls and back off on HTTP 429 or provider code 40008.
>
> #### Input Parameters
>
> **user\_ids** `array`
>
> Developer user IDs to query, up to 100 per request. Pass one ID or a list of IDs. Provide exactly one of this field or anonymous\_ids.
>
> **anonymous\_ids** `array`
>
> Anonymous or device IDs to query, up to 100 per request. Pass one ID or a list of IDs. Provide exactly one of this field or user\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message
>
> **Slug:** `GPTBOTS_SEND_MESSAGE`
>
> Send the latest user text to a GPTBots conversation in blocking mode; a response may signal a Custom Helpdesk human handoff, or the message may be archived without an AI response during human takeover. Avoid blindly retrying after ambiguous acceptance; reconcile through conversation messages first.
>
> #### Input Parameters
>
> **message** `string` *required*
>
> Latest user text to send. GPTBots uses stored conversation memory, so prior turns normally should not be repeated.
>
> **conversation\_id** `string` *required*
>
> Conversation ID returned by Create Conversation.
>
> **custom\_variables** `object`
>
> Agent-defined custom variable names and JSON values for this call. Keys must match variables configured on the connected Agent.
>
> **long\_term\_memory** `boolean`
>
> Optional per-call override for the Agent's long-term memory setting; omit to use the Agent default.
>
> **short\_term\_memory** `boolean`
>
> Optional per-call override for the Agent's short-term memory setting; omit to use the Agent default.
>
> **knowledge\_base\_ids** `array`
>
> Optional knowledge base IDs that constrain retrieval for this message. They are combined as a union with knowledge\_document\_ids. Omit both fields to use Agent defaults, or pass both as empty arrays to disable knowledge retrieval.
>
> **knowledge\_document\_ids** `array`
>
> Optional knowledge document IDs that constrain retrieval for this message. They are combined as a union with knowledge\_base\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
