Documentation

Everything you need to know about Helpmaton

Quick Answers to Common Questions

Looking for quick answers? Check out our FAQ page covering setup, agents, workspaces, billing, API, and more.

View FAQ →

Getting Started

New to Helpmaton? Start here! We'll guide you through creating your first workspace, setting up agents, and uploading documents.

Read Getting Started Guide →

Working with Agents

Learn how to create, configure, and manage your AI agents. From basic setup to advanced configurations, we've got you covered.

  • Creating your first agent
  • Configuring agent personalities
  • Setting up agent workflows
  • Managing multiple agents

Agent Memory System

Agents remember important facts, people, and events from conversations through an advanced memory system. This enables context-aware responses informed by past interactions.

  • Advanced memory system organized by time periods
  • Progressive summarization (daily, weekly, monthly, quarterly, yearly)
  • Smart search for memory retrieval
  • Plan-based memory retention (Free: 48h working + 30d summaries, Pro: 240h + 120d)
  • Automatic memory cleanup and management

Workspaces

Organize your AI agents into workspaces. Each workspace is like a separate container with its own settings, credits, and team members.

Note: Workspace credits are used for AI provider calls (OpenAI, Anthropic, etc.), not for platform subscription costs. You can either provide your own API keys or purchase credits through Helpmaton.

  • Creating and managing workspaces
  • Setting spending limits (for AI provider costs)
  • Adding your own API keys or purchasing credits
  • Team collaboration and subscription sharing (Pro plans support unlimited managers)
  • Workspace permissions

Documents

Upload and organize documents to give your agents knowledge. Learn about supported formats, organization, and best practices.

  • Uploading documents
  • Organizing with folders
  • Supported file formats
  • Document management tips

Usage Analytics & Monitoring

Comprehensive usage tracking and monitoring tools to help you understand and optimize your AI spending. View detailed analytics across all dimensions of your usage.

  • Usage tracking (all AI request types)
  • Daily and hourly aggregation
  • Historical data with date range filtering
  • Per-workspace and per-agent breakdowns
  • Cost tracking and budget monitoring

Web Search & Content Extraction

Give your agents access to real-time, up-to-date information beyond their training data. Enable web search and content extraction tools to make your AI assistants more capable and current.

Web Search (search_web)

Agents can search the web for current information, news, articles, and research. Perfect for finding the latest developments, answering questions about recent events, or discovering new resources. Search results include titles, URLs, content snippets, and relevance scores.

  • Find current information that isn't in training data
  • Answer questions about recent events and developments
  • Discover new articles and resources
  • Get real-time information for research assistants

Content Extraction (fetch_web)

Extract and summarize content from any web page URL. Agents can read and understand specific web pages, analyze articles, extract key information, and provide insights from any online content.

  • Extract main content from web pages
  • Summarize articles and online resources
  • Analyze web content for insights
  • Perfect for content analysis workflows

Pricing

All plans include 10 free web search calls per 24 hours. Additional calls are billed at $0.008 per call. This gives you access to real-time information at a transparent, cost-effective rate.

  • Free tier: 10 calls per 24 hours included
  • Paid tiers: 10 free calls per day, then $0.008 per additional call
  • Perfect for research assistants, news monitoring, and content analysis

Enabling Web Search

Enable web search and content extraction per-agent with simple toggle switches:

  • Go to your agent's configuration page
  • Find the "Web Search" and "Content Extraction" toggles
  • Enable the features you want (web search, content extraction, or both)
  • Your agents can now access real-time information!

Web search and content extraction are powerful tools that extend your agents' capabilities beyond their training data, enabling them to provide current, relevant information for research, news monitoring, and content analysis workflows.

Webhooks & Integrations

Connect Helpmaton to your existing tools and workflows. Set up webhooks, integrate with APIs, and automate your processes.

  • Setting up webhooks
  • Real-time streaming with Server-Sent Events (SSE)
  • Webhook events and payloads
  • Integration examples
  • Troubleshooting webhooks

Built-in Tools & External Integrations

Agents come with a comprehensive set of built-in tools and can be extended with external integrations to connect to external APIs and services.

Built-in Tools

Every agent has access to these powerful tools out of the box:

  • Document Search: Smart search across workspace documents
  • Memory Search: Recall past conversations and information from the agent's memory system
  • Web Search: Search the web for current information, news, and articles
  • Web Fetch: Extract and summarize content from any web page URL
  • Email Sending: Send emails using workspace email connections
  • Notification Sending: Send notifications to Discord channels (with API support for Slack)
  • Agent Delegation: Agents can delegate tasks to other agents in the workspace

External Integrations (Extensibility)

Extend your agents' capabilities with external integrations. Connect to external APIs, databases, and custom tools to enable powerful integrations.

  • What are external integrations?
  • Configuring external connections with custom authentication
  • Enabling external integrations per-agent
  • Authentication and security
  • Use cases and examples

Google Workspace Integration

Connect your agents to Gmail, Google Calendar, and Google Drive with easy OAuth setup. Just connect your Google account—no complex configuration or API keys needed. Your agents can manage your calendar, read and search emails, and access Drive files.

Easy OAuth Setup

Setting up Google Workspace integration is simple and secure:

  • Go to "Integrations" in your workspace settings
  • Create an MCP server for the Google service you want (Gmail, Calendar, or Drive)
  • Click "Connect Google Account" and sign in
  • Grant the necessary permissions
  • Enable the connection for your agents

All connections use secure OAuth 2.0 authentication to keep your data private and secure.

Gmail Integration

Connect agents to Gmail accounts via OAuth, enabling agents to:

  • List and search emails using Gmail's powerful search syntax
  • Read full email content including headers, body, and attachments
  • Search using queries like "from:example@gmail.com", "subject:meeting", "is:unread"
  • Perfect for email management, filtering, and automated email workflows

Google Calendar Integration

Connect agents to Google Calendar for full calendar management:

  • List events and search by query
  • Read event details including attendees, times, and descriptions
  • Create new events and update existing ones
  • Delete events when needed
  • Perfect for scheduling assistants, meeting coordinators, and calendar management workflows

Google Drive Integration

Give agents access to files stored in Google Drive:

  • Read text files and documents
  • Access Google Docs (exported as plain text)
  • Read Google Sheets (exported as CSV)
  • Access Google Slides (exported as plain text)
  • Ideal for document analysis, data extraction, and content management workflows

Google Workspace integrations enable powerful automation workflows where your agents can interact with your Google services seamlessly. See the MCP Servers documentation for detailed setup instructions.

Notion Integration

Connect your agents to Notion with easy OAuth setup. Just connect your Notion account—no complex configuration or API keys needed. Your agents can read and search pages, create and update content, query databases, and manage your Notion workspace.

Easy OAuth Setup

Setting up Notion integration is simple and secure:

  • Go to "Integrations" in your workspace settings
  • Create an MCP server and select "Notion"
  • Click "Connect Notion Account" and sign in
  • Grant the necessary permissions
  • Enable the connection for your agents

All connections use secure OAuth authentication to keep your data private and secure.

Page Management

Agents can read, search, create, and update Notion pages:

  • Read any page by its ID, including properties, metadata, and content
  • Search for pages, databases, and data sources across your workspace
  • Create new pages with simplified parameters (name and content) or advanced options
  • Update page properties and content
  • Append blocks (paragraphs, headings, lists) to existing pages

Database Management

Agents can query and manage Notion databases:

  • Query databases with filters and sorts to find specific records
  • Create new pages in databases with properties matching the schema
  • Update database page properties
  • Perfect for knowledge management, project tracking, and data workflows

Notion integration enables powerful knowledge management workflows where your agents can interact with your Notion workspace seamlessly. Perfect for documentation assistants, knowledge bases, and content management. See the MCP Servers documentation for detailed setup instructions.

Error Tracking

Conversations automatically persist and display errors when AI requests fail, making it easy to identify and debug issues in your AI agent workflows.

  • Automatic error persistence in conversations
  • Detailed error messages with stack traces
  • Provider information and metadata for debugging
  • Error badges in conversation lists for quick identification
  • Detailed error views with full context
  • Historical error tracking across conversations

Error tracking works automatically - no configuration needed. When AI requests fail, errors are immediately visible in your conversation interface.

Agent Delegation

Agents can delegate tasks to other agents in the workspace, enabling complex multi-agent workflows and sophisticated task orchestration.

  • How agent delegation works
  • Setting up multi-agent workflows
  • Task distribution and coordination
  • Specialized agent teams
  • Use cases for agent collaboration
  • Best practices for delegation patterns

Agent delegation enables you to build sophisticated systems where agents collaborate, share responsibilities, and handle specialized tasks.

Email Sending

Configure email authentication for your workspace to enable agents to send emails using workspace email connections.

  • Configuring workspace email connections
  • Setting up SMTP authentication
  • Using the email sending tool in agents
  • Email templates and formatting
  • Best practices for agent email communications

Chat Platform Bot Integration

Deploy your agents as Slack or Discord bots, enabling team members and community users to interact with your AI agents directly in their favorite chat platforms. This is different from notification channels—bots are interactive agents that respond to user messages.

Slack Bot Integration

Deploy agents as Slack bots that respond to mentions and direct messages. Create integrations that connect your agents to Slack workspaces with full support for mentions, commands, and direct messages.

  • Dynamic Slack App Manifest generation for easy setup
  • Secure webhook handling with signature verification
  • Throttled message updates for streaming-like experience
  • Support for both channel mentions and direct messages
  • Unified management from Integrations page

See the Slack Integration guide for detailed setup instructions.

Discord Bot Integration

Deploy agents as Discord bots with slash command support. Create integrations that connect your agents to Discord servers with full support for Discord's interaction system.

  • Ed25519 signature verification for secure interactions
  • Throttled message updates for real-time responses
  • Full support for Discord's interaction system
  • Slash command support
  • Unified management from Integrations page

See the Discord Integration guide for detailed setup instructions.

Key Features

  • Unified Management: Manage all integrations from a single Integrations page
  • Secure by Default: Platform-specific signature verification ensures only legitimate requests are processed
  • Easy Setup: Step-by-step guides for both platforms with manifest generation
  • Streaming Simulation: Throttled message updates provide near-real-time response experience
  • Full Agent Capabilities: Bots have access to all agent tools, memory, and knowledge bases

Chat platform bot integration enables your agents to be interactive participants in Slack workspaces and Discord servers, responding to user messages and commands in real-time.

Notification Channels

Configure notification channels for your workspaces to enable agents to send messages to external platforms like Discord and Slack. This is different from bot deployment—notification channels are one-way communication for alerts and updates, while bots are interactive agents that respond to user messages.

Discord Integration

Create Discord channels with bot tokens and channel IDs. Agents can use the send_notification tool to deliver messages to configured channels.

  • Setting up Discord bot tokens
  • Configuring channel IDs
  • Testing notification delivery

Slack Integration

Configure Slack webhooks via the API to enable agents to send notifications to Slack channels.

  • Setting up Slack webhooks
  • Configuring via API
  • Channel configuration

Notification channels are perfect for alerts, updates, and automated communications from your AI agents.

Billing & Pricing

Understanding Helpmaton's pricing structure and how costs work.

What's Included in Your Subscription

Your monthly subscription covers all Helpmaton platform services:

  • Hosting and infrastructure
  • Agent configuration and management
  • Agent memory system and analytics
  • Workspaces and team collaboration
  • Document storage and search
  • All Helpmaton-related API calls

AI Provider Calls (Separate)

AI provider calls (OpenAI, Anthropic, Google, etc.) are not included in your subscription. You have two flexible options:

  • Use your own API keys: Connect your own AI provider API keys and pay providers directly while enjoying all Helpmaton features
  • Purchase credits: Buy credits through Helpmaton for usage-based billing with transparent pricing

Cost Control & Spending Limits

Set granular spending limits to maintain budget control:

  • Daily, monthly, or yearly spending limits
  • Limits at both workspace and individual agent levels
  • Automatic credit reservation with atomic operations
  • Advanced pricing support (tiered rates, reasoning tokens, cached tokens)

This separation keeps your platform costs predictable while giving you complete flexibility in how you handle AI provider costs.

API Reference (For Developers)

For developers who want to integrate Helpmaton programmatically. Full API documentation with examples and code snippets.

OpenAPI Documentation

Complete API documentation available in OpenAPI format. Generate client libraries, explore endpoints, and understand request/response schemas.

Flexible Authentication

Multiple authentication methods to fit your workflow: session-based authentication for web users, JWT tokens (24-hour expiration) for API access, workspace API keys for programmatic integration, and OAuth support.

Comprehensive API Coverage

Full programmatic access to all platform features including:

  • Workspace and agent management
  • Document upload and organization
  • Error tracking and conversation history
  • Usage analytics and monitoring
  • Notification channel configuration
  • External integration management
  • Webhook endpoints and streaming
View API Reference →

Self-Hosting

Helpmaton is open source! The source code is available on GitHub, so you can spin up your own instance, customize it to your needs, and run it on your own infrastructure. Full control, zero vendor lock-in.

  • Complete source code available
  • Setup instructions included
  • Customize to your needs
  • Run on your own infrastructure
View on GitHub →

Need Help?

Can't find what you're looking for? Our support team is here to help!