Documentation Index
Fetch the complete documentation index at: https://docs.boostgpt.co/llms.txt
Use this file to discover all available pages before exploring further.
Agent templates
Export any agent as a portable.boostgpt file and import it to create a new agent or update an existing one:- Full config export — captures instruction, model, capabilities (memory, sandbox, heartbeat, etc.), branding, tool connections, artifact settings, and upload rules
- One-click import — import when creating a new agent or apply to an existing agent from Settings → Agent Template
- Predefined connector auto-provisioning — tools like HubSpot, Slack, and Twitter are automatically wired up during import; connect your credentials in the Tools tab
- Credential-safe — API keys and OAuth tokens are never included in exported files
- Plain JSON —
.boostgptfiles are human-readable and can be version-controlled alongside your code
Chat widget
Embed any agent on any website as a floating chat bubble — one script tag:- Full agent experience — workspace, tools, file uploads, and custom interfaces all work inside the widget
- Branding — bubble inherits your accent color, avatar, and greeting messages. 16 built-in SVG icons or use your bot avatar
- Greeting bubbles — stacked message cards from your branding settings appear above the floating button
- New chat button — accent-colored header with bot name, reload icon, and close button
- Chat persistence — conversations persist across page refreshes via localStorage
- Mobile responsive — full-screen overlay on small viewports
- Auto-open — optionally open the widget after a configurable delay
- Programmatic API —
open(),close(),toggle(),hide(),show(),destroy(), and event listeners - Framework support — setup guides for HTML, Next.js, Nuxt.js, React, Vue, and SvelteKit
Widget SSO
Auto-identify users in the chat widget without requiring them to log in again:- JWT-based — your backend signs a token with the bot’s SSO secret. The widget verifies it server-side.
- Auto-provisioning — if the user doesn’t exist, BoostGPT creates their account and subscriber record automatically
- Chat history — identified users get persistent conversations and user memory across sessions
- Skip login gates — SSO users bypass
require_loginsettings - Secure — tokens expire (1h), are signed (HS256), and the secret is never exposed client-side
Agent marketplace
Bot owners can now submit their agents to a public marketplace:- App-store model — agents go through
draft → pending_review → approvedstatus flow with staff review - Ratings & reviews — users rate agents 1–5 stars with optional written reviews. Cached aggregates for fast display.
- Public browse — search by name, category, or featured status. Sorted by rating and views.
- Creator dashboard — view all your listings, update metadata, resubmit rejected listings, or withdraw
- Admin review — staff can approve, reject (with notes), or suspend listings
Pluggable agent interfaces
Agents can now build custom HTML interfaces and activate them as the chat UI — replacing the default message view with a fully interactive app:set_interfacetool — agents call this built-in tool to activate any workspace HTML file as the chat interface- Bridge SDK — auto-injected JavaScript SDK (
window.BoostGPT) that lets custom interfaces communicate with the chat system via postMessage - Bidirectional API — interfaces can send messages (
chat.sendMessage), read files (workspace.readFile), listen for responses (chat.onResponse), approve tools, and more - Per-chat or default — set an interface for a single conversation or as the bot’s default interface for all new chats
- Real-time updates —
workspace.onFileChange()auto-refreshes the interface when the agent updates data files - Dashboard controls — “Set as Chat Interface” and “Set as Default Interface” context menu actions in the workspace file explorer
chat, workspace, tools, schedule, bot, ui — full programmatic access to the agent’s capabilities from within custom HTML.This enables agents that deliver full applications — fitness trackers, dashboards, interactive tutorials, data visualizations — not just text responses.Workspace scope
Bot owners can now choose how workspaces are scoped for authenticated users:- Per Account (default) — one workspace shared across all conversations. Files persist between chats.
- Per Chat — each conversation gets its own isolated workspace. Ideal for tutoring, code reviews, and sandbox experiments.
Code sandbox
Agents can now run code in isolated Microsandbox microVMs — not simulated, actually executed:commandbuilt-in tool — agents write and execute shell commands, Python scripts, or Node.js code in a secure sandbox- Isolated microVMs — each execution runs in its own container with 512MB–2GB RAM, 1–2 CPUs, and 30–180s timeout (varies by plan)
- File sync — workspace files are pushed to the sandbox before execution, results synced back
- Runtime auto-detection — automatically selects Python or Node.js based on file extensions in the workspace
- Output capture — stdout, stderr, and exit codes returned to the agent. Non-zero exit codes flagged with warnings.
- Large file support — files over 60KB are chunked to avoid system limits
Agent email
Every agent now gets its own email address:- Unique address — each agent receives an email like
youragent@boostgpt.page - AI-powered replies — users email your agent and receive AI responses based on the agent’s instruction and training data
- Dashboard integration — email conversations appear alongside chat conversations in your dashboard
- Subscriber capture — email senders are automatically added as subscribers
- Custom email templates — customize verification, welcome, password reset, subscription, and credit notification emails with your branding
Built-in agent tools
Agents inagent reasoning mode now have access to 22 built-in tools across 8 categories — no configuration required:- Knowledge —
search_memoryfor vector search through training data,screenshotfor capturing web pages,web_fetchfor extracting page content as markdown - User Memory —
remember,recall,list_memories,forgetfor managing per-user long-term memory - Files —
write,read,edit,grep,deletefor sandbox workspace operations - Planning —
create_plan,update_plan,read_plan,accept_planfor structured multi-step workflows - Communication —
ask_userfor structured questions with selectable options,notify_userfor proactive notifications,message_agentfor cross-agent messaging - Execution —
commandfor running code and shell commands in an isolated sandbox - Automation —
schedule_taskfor recurring scheduled tasks - Utility —
thinkfor internal reasoning without user-visible output
Workspaces
Agents now have a sandbox file system — isolated workspaces where they can create, read, edit, search, and delete files:- Built-in tools —
write,read,edit,grep, anddeletetools available to agents inagentreasoning mode - Per-user isolation — authenticated users get their own workspace per agent, anonymous users get a chat-scoped workspace
- File explorer — built-in file tree UI with syntax-highlighted code viewer
- Real-time sync — files created or edited by the agent appear instantly in the workspace explorer
- REST API — full workspace and file management via the API for programmatic access
Agent reasoning mode
The reasoning system has been simplified to three modes:auto— automatically selects the best approach for each requeststandard— quick, single-pass answers (1x credit)agent— autonomous multi-step reasoning with tool use (up to 10x credit)
agent mode replaces the previous interactive, stepwise, and react modes with a unified autonomous agent loop that can read files, search, edit code, execute tools, and plan multi-step workflows.Deprecated: interactive, stepwise, and react reasoning modes are no longer supported. Use agent instead.Plan chat mode
Conversational “plan-then-execute” workflow for multi-step tasks:- Plan mode (
chat_mode: 'plan') — AI proposes a step-by-step plan before executing any tools - Approve / Modify / New — approve to execute, reply with changes to revise, or start a fresh plan
- Tool-aware plans — the AI considers all available tools (built-in and connected integrations) when generating plans
- Direct answers — if no tools are needed, bypasses planning and responds directly
Edit chat mode
Agent-powered code editing through the agent reasoning pipeline:- Edit mode (
chat_mode: 'edit') — routes your request through the agent, which uses the built-inedittool for targeted file changes - Toggle switch — Chat/Edit/Plan toggle next to the send button
- Edit button — per-message “Edit” action on system messages with code blocks
- Smart editing — the agent analyzes your request, locates the right file, and applies precise string replacements
- Multi-step edits — the agent can chain multiple edits across files in a single turn
Heartbeat scheduling
Transform agents from passive chatbots into proactive autonomous assistants:- Autonomous execution — agents wake up on a timer, execute a prompt, use connected tools, and report back
- Flexible scheduling — configurable intervals, active hours, active days, and timezone support
- notify_user — agents can send notifications (email, in-app) to subscribers during execution
- schedule_task — agents can create their own recurring tasks for follow-up actions
- message_agent — agent-to-agent async communication for multi-agent workflows
Safety controls
- Circuit breaker — auto-pause after consecutive failures (configurable threshold)
- Credit budgets — per-heartbeat spending limits that reset monthly
- Plan-tier caps — maximum heartbeats per agent and minimum intervals enforced per plan
- Bot-level toggle — per-agent heartbeat enable/disable in Settings → Features & Options
Execution dashboard
- Logs — every execution with status, duration, tokens, and credits charged
- Activity chart — daily visualization of execution volume
- Stats — success rate, type breakdowns, and time-series data
API access
Full heartbeat management via the external API (/v1/bot/heartbeat/*) — create, list, enable, disable, trigger, delete, view logs, and get stats programmatically.See the Heartbeat guide for no-code setup or the Heartbeat API for programmatic access.User memory
Agents now remember user preferences, facts, and context across conversations:- Automatic memory — agents learn and store important details (names, preferences, decisions) from natural conversation
- Per-user isolation — each user has their own private memory store, separate from agent training data
- Memory bootstrap — relevant memories are automatically injected into context at the start of each conversation
- Vector-powered recall — memories are semantically searchable, so the most relevant context surfaces automatically
- Memory management — view and delete per-user memories from the Subscribers page in the dashboard
Context compaction
Long conversations no longer hit context window limits:- Automatic compaction — when conversation context reaches 70% of the model’s limit, older messages are summarized
- Memory-safe — important facts are extracted and saved to user memory before compaction
- Model-aware — compaction threshold adapts to each model’s actual context window size
- Transparent — recent messages are preserved intact, only older history is summarized
Proactive trigger system
Transform your agents from passive chatbots into proactive assistants that reach out at the right moment:- Smart triggers: Fire events based on user behavior (errors, cart abandonment, page visits)
- Multiple UI types: Button, toast notification, banner, or inline embed
- Customizable appearance: Colors, text, positioning, animations
- Delayed triggers: Show help after a configurable delay
Screenshot capture
Capture visual context when triggers fire to give your agent full situational awareness:- Automatic screenshots: Capture the page when users click the trigger
- Quality control: Configurable JPEG quality and max dimensions
- Privacy-first: Opt-in only, users must enable per-trigger
- Requires html2canvas: Lightweight dependency (~40KB gzipped)
Multi-bot routing
Route different events to specialized agents on the same page:- Per-trigger botId: Override the default agent for specific triggers
- Specialized agents: Sales bot for pricing, support bot for errors, billing bot for invoices
- No re-initialization: Switch between bots without calling init() again
Rich context passing
Provide your agents with full situational context:- Source URL: Agents know which page the user is on
- Custom context: Pass any data (cart value, error codes, user info)
- User identification: Associate triggers with logged-in users
- Prompt templates: Use
{{context.field}}in agent instructions
Reasoning models support
- OpenAI O-Series: O1, O1 Mini, O3 Mini with extended thinking
- Claude 3 Opus: Extended thinking capabilities
- Google Gemini: 2.0 Flash Thinking mode
- xAI Grok: Grok 3 Reasoning
- DeepSeek R1: Cost-effective reasoning model
- Multiple reasoning modes:
auto,standard,agent
Expanded model catalog
- 50+ models across 9 AI providers
- GPT-5 series: GPT-5, GPT-5.1, GPT-5-mini, GPT-5-nano
- GPT-4.1 series: GPT-4.1, GPT-4.1-mini
- Claude 4.5 series: claude-sonnet-4-5, claude-haiku-4-5
- Gemini: Gemini 3, Gemini 2.5 Pro, Gemini 2.5 Flash Lite
- Grok: Grok 4.1, Grok 4, Grok 3 variants
New provider support
- xAI integration
- DeepSeek integration
- Existing: OpenAI, Google, Anthropic, Mistral, Cohere, Groq, Ollama
No-code agent creation
- Visual dashboard interface: Create agents without writing any code
- Quick setup: Get started in under 5 minutes
- Custom branding: Fully branded agent pages with custom domains
- Multiple deployment options: Embed widgets, standalone pages, or custom URLs
Training made simple
- File uploads: Drag-and-drop PDF, Word, and text files
- URL-based training: Add website content with one click
- Direct text input: Paste content directly into the builder
- Memory management tab: Simplified interface for managing training data
Lead capture & monetization
- Email gating: Built-in lead capture forms
- 94%+ conversion rates: Optimized for maximum subscriber growth
- Lead analytics: Track and export subscriber data
- Integration ready: Connect with your existing CRM and marketing tools
Custom branding & design
- White-label experience: Remove BoostGPT branding
- Custom themes: Choose colors, logos, and styling
- Conversation starters: Pre-configured example questions
- Custom greetings: Personalized welcome messages
MCP server generation
- Auto-generate from OpenAPI specs: Convert any OpenAPI specification to MCP server
- Postman collection import: Transform Postman collections into MCP servers
- Managed hosting: Custom MCP URLs at
https://mcp.your-server-id.boostgpt.co - External compatibility: Use with Claude Desktop, ChatGPT, and other MCP-compatible agents
Pre-built connector library
45+ ready-to-use connectors including:- Calendar: Calendly, Google Calendar, Cal.com, Outlook
- Email: Gmail, Outlook, SendGrid, Mailchimp, Twilio
- CRM: HubSpot, Salesforce, Pipedrive, Zoho
- Productivity: Notion, Asana, Jira, Linear, Trello, ClickUp, Monday.com
- Storage: Google Drive, Dropbox, OneDrive
- Development: GitHub, Vercel, Netlify
- Analytics: Google Analytics, Mixpanel, Datadog, Sentry
- AI & Media: Stability AI, Runway, Kling AI, Luma Labs, Unsplash, Pexels
- E-Commerce: Shopify, WooCommerce, Stripe
- Communication: Discord, Slack
Multi-platform support
- Discord: Full Discord bot integration
- Telegram: Telegram bot adapter
- Slack: Slack workspace integration
- WhatsApp: WhatsApp Business API support
- Crisp: Live chat integration
- Custom adapters: Build your own platform adapters
Custom adapter framework
- Standardized adapter interface
- Example Twitter adapter provided
- Event-driven architecture
- Message routing and context management
Event subscriptions
bot.created- New bot creation eventsbot.updated- Bot configuration changesbot.deleted- Bot deletion eventschat.message- New chat message eventssubscriber.added- New subscriber capturetraining.added- Training data additions
Security features
- HMAC SHA-256 signature verification
x-boostgpt-signatureheader validation- Secure event delivery
- Webhook testing with ngrok support
Advanced chat parameters
- reasoning_mode: Choose from
auto,standard,agent - temperature: Control model creativity (0-1 range)
- model override: Change models per request
- provider_host: Self-hosted Ollama support
- provider_key: Bring Your Own Key (BYOK) for any provider
- source_ids: Target specific training sources
- memory control: Toggle agent memory per request
Response customization
- Real-time streaming with
streamparameter - Token limit control with
max_reply_tokens - Instruction override per request
- Conversation context with
chat_id
Training capabilities
- Multiple source types: Text, websites, files, multiple URLs
- Status tracking: Monitor processing status (
processing,success,failed) - Token usage: Track tokens per training item
- Source management: Update and delete training data
- Website crawling: Train on entire domains
Supported formats
- PDF documents
- Word documents (DOCX)
- Text files
- Markdown files
- CSV files
- PowerPoint presentations
File upload functionality
- Added file upload capability to chatbot builder source management
- Users can now upload files directly within the source management feature
- Train your AI bot with local documents more efficiently
Chat UI improvements
- Updated chat interface to display messages in bubbles
- Redesigned for more engaging and intuitive user experience
- Enhanced aesthetics and readability of chat feature
Message retry functionality
- Implemented “failed to send. Retry” feature for chat messages
- Informative prompts when network issues prevent message delivery
- Option to retry sending failed messages
- Improved message delivery status visibility
Network connectivity handling
- Event stream automatically stops when network connection is lost
- Prevents unnecessary data requests and reduces potential errors
- Smoother user experience during network interruptions
- Prevents data inconsistencies
Build your own AI Assistant
- Create fully personalized AI Assistants
- Customize and configure according to specific requirements
- Enhanced flexibility and versatility
Zapier integration
- Automate chatbot workflows with Zapier integration
- Seamless data exchange between chatbot and other applications
- Streamlined processes and improved productivity
Subscriber list growth
- Leverage AI Assistant to grow subscriber lists
- Facilitate seamless interaction and engagement
- Enhanced subscription management capabilities
bot/subscriber/readall endpoint
- New API endpoint to fetch all subscribers associated with a bot
- Retrieve comprehensive list of subscribers in a single request
- Streamlined method for accessing subscriber data
- Simplified subscriber information retrieval for analysis, management, and reporting
bot/chat/readall endpoint
- Introducing chats pulling functionality for chatbots
- Effortlessly retrieve all chats in a bot
- Access valuable insights and information
- Enhance analysis and improve customer support
- Drive data-driven decisions
bot/chat/read endpoint
- Chat history pulling functionality for specific static chat_id
- Effortlessly retrieve chat history
- Access past conversations for enhanced analysis
- Improve customer support with conversation insights
- Drive data-driven decisions
bot/chat/delete endpoint
- Enable chat history deletion for specific static chat_id
- Users can reset conversations with the bot
- Enhanced user control over chat history
- Promotes fresh starts with the bot
Response streaming control
- Added “stream” parameter to bot/chat endpoint
- Customize response delivery behavior
- Choose between partial progress updates or complete response
- Set stream to
truefor real-time updates orfalseto wait for complete response
Conversational chat support
- Introduced chat_id parameter to bot/chat endpoint
- Engage with AI bot in conversational manner
- Maintain context across multiple messages
- Enhanced user experience with continuous conversations
Multiple file link support
- Added support for multiple file links in bot training
- Updated source/create and source/update endpoints
- Train bots using wider variety of file sources
- Improved accuracy and effectiveness with diverse training data
Supported file types
- CSV files
- PowerPoint presentations (PPT)
- Word documents (DOC)
- PDF documents
- Markdown files (MD)
- Text files (TXT)
Multiple webpage link support
- Added support for multiple webpage links when training bots
- Updated source/create and source/update endpoints
- Enhanced training capabilities with multiple web sources
- Improved bot accuracy and response quality