Skip to main content
GPTBots logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: GPTBOTS
  • Version: 20261101_00

Tools

Slug: GPTBOTS_CREATE_CONVERSATIONCreate 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

string
required
Developer-defined user ID used for conversation memory, user attributes, and analytics. Maximum 32 characters.
string
Device or anonymous-user ID to bind to the conversation. Omit it to let GPTBots generate an anonymous ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_GET_AGENT_INFORMATIONReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_GET_TOTAL_CREDIT_CONSUMPTIONReturn 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

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.
integer
required
Start of the reporting range as a Unix timestamp in milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_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. 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

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.
integer
Conversation usage records per page (1-100).
integer
required
Start of the reporting range as a Unix timestamp in milliseconds.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Conversation ID to filter by; omit to include all conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_CONVERSATION_MESSAGESReturn 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

integer
Messages to return in this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Conversation whose message history to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_CONVERSATIONSReturn 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

string
Developer user ID to filter by; omit to include all users.
integer
required
End of the recent-chat time range as a Unix timestamp in milliseconds; must not precede start_time.
integer
Conversations per page (10-100).
integer
required
Start of the recent-chat time range as a Unix timestamp in milliseconds.
string
Continuation cursor returned by a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
string
Conversation source filter, such as ALL, API, or EMBED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_DATABASE_TABLESReturn 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

string
required
Agent ID (bot_id) returned by Get Agent Information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_KNOWLEDGE_BASESReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_KNOWLEDGE_DOCUMENTSReturn 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

integer
Documents to return in this page (10-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string
required
Knowledge base ID, obtainable from List Knowledge Bases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_LIST_METADATA_FIELDSReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_QUERY_USER_ATTRIBUTESReturn 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GPTBOTS_SEND_MESSAGESend 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

string
required
Latest user text to send. GPTBots uses stored conversation memory, so prior turns normally should not be repeated.
string
required
Conversation ID returned by Create Conversation.
object
Agent-defined custom variable names and JSON values for this call. Keys must match variables configured on the connected Agent.
boolean
Optional per-call override for the Agent’s long-term memory setting; omit to use the Agent default.
boolean
Optional per-call override for the Agent’s short-term memory setting; omit to use the Agent default.
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.
array
Optional knowledge document IDs that constrain retrieval for this message. They are combined as a union with knowledge_base_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not