Documentation

Everything you need to get started with Helpmaton

Related resources

Quick links to other helpful pages.

❓

Quick Answers to Common Questions

Looking for quick answers? Our FAQ covers setup, agents, workspaces, billing, 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 and manage your AI agents, from basic setup to more advanced options.

  • Creating your first agent
  • Setting agent tone and instructions
  • Enabling tools and integrations
  • Enabling skills for effective tool usage
  • Scheduling recurring work
  • Delegating tasks to other agents
  • Reviewing quality with evals

Evaluation & Quality Control (Judge Evals)

Use judge evaluations to score conversations, validate outcomes, and catch regressions after you change prompts, tools, or integrations.

  • Run evals with just a couple of clicks
  • Score outcomes and track quality over time
  • Use sampling to balance insight and cost
  • Validate behavior before shipping changes

Agent Memory System

Agents remember key details from conversations so they can respond with more helpful context.

  • Memory grouped by time periods
  • Summaries created over time (daily, weekly, monthly, etc.)
  • Custom summarization prompts per agent and time grain
  • Smart search to find past details
  • Memory length depends on your plan (Free: 48h + 30d summaries, Pro: 240h + 120d)
  • Automatic cleanup to save space

Workspaces

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

Note: Your first workspace is credited with $2 to get started. After that, workspace credits cover AI provider usage, not your Helpmaton subscription. You can use your own API keys or buy credits through Helpmaton.

  • Creating and managing workspaces
  • Setting spending limits for AI usage
  • Agent-specific limits with daily, monthly, or yearly caps
  • Using your own API keys or buying credits
  • Team collaboration and shared access (Pro plans support unlimited managers)
  • Workspace permissions

Documents

Upload and organize documents so your agents can use them as a knowledge base.

Document formats: Knowledge base documents support Markdown and text. For other file types and images, use conversation attachments.

  • Uploading documents
  • Organizing with folders
  • Supported formats: Markdown + text
  • Document management tips

Conversation Attachments

Attach files and images directly to a conversation to give your agent richer context for troubleshooting, review, and multi-modal workflows.

  • Attach files and images while chatting
  • Great for screenshots, reports, and file reviews
  • Different from knowledge base documents

Usage Analytics & Monitoring

Track usage so you can understand and manage your AI spending. View clear reports across your work.

  • Usage tracking for all AI requests
  • Daily and hourly summaries
  • History by date range
  • Breakdowns by workspace and agent
  • Cost tracking and budget checks

Web Search & Content Extraction

Give your agents access to up-to-date information. Enable web search and content extraction so they can look things up and summarize pages.

Web Search

Agents can search the web for current information, news, and research. Results include titles, links, and short summaries.

  • Find current information
  • Answer questions about recent events
  • Discover new articles and resources
  • Support research and monitoring

Content Extraction

Give a URL and the agent will read and summarize that page.

  • Extract the main content
  • Summarize articles and resources
  • Pull key points from pages

Pricing

All plans include a daily allowance, with low-cost pay-as-you-go pricing after that.

Turn on web search and content extraction per agent in settings.

Web search and content extraction help your agents provide current information when you need it.

Webhooks & Integrations

Connect Helpmaton to your tools and workflows. Set up webhooks and automate common tasks.

  • Setting up webhooks
  • Real-time updates
  • Streaming responses (SSE) for chat-like experiences
  • Webhook events and payloads
  • Integration examples
  • Troubleshooting

Agent Schedules

Automate agent runs with cron-based schedules. Perfect for recurring reports, proactive monitoring, and routine operational tasks.

  • Run agents on a schedule with cron expressions
  • Send results to email or notification channels
  • Combine schedules with web search and integrations

Built-in Tools & External Integrations

Agents come with built-in tools and can connect to external services when you need more.

Built-in Tools

Every agent has access to these tools:

  • Document Search: Find information in your documents
  • Memory Search: Recall past conversations and details
  • Web Search: Look up current information and articles
  • Web Fetch: Read and summarize a web page
  • Email Sending: Send emails from your workspace
  • Notification Sending: Send updates to Discord or Slack
  • Agent Delegation: Pass tasks to other agents

External Integrations (Extensibility)

Extend your agents with external integrations (MCP servers), like APIs, databases, and custom tools.

  • What external integrations are
  • Setting up connections with authentication
  • Enabling integrations per agent
  • Security basics
  • Use cases and examples

Agent Skills

Agent Skills are optional instruction blocks appended to an agent's system prompt. They teach agents how to use their tools effectively with step-by-step guidance, examples, and edge-case handling for specific workflows.

How it works

Enable tools (MCP servers or built-in tools like document search, web search, email) for your agent, then pick from available skills that match those tools. Each skill is only available when all its required tools are enabled and connected.

Benefits

  • Better tool usage: agents follow structured instructions instead of guessing
  • Domain expertise: skills include examples, edge cases, and tool-specific guidance
  • Easy configuration: enable skills per agent from Agent detail → External tools → Skills
  • Export/import: skills are included in workspace export for reproducible setups

See the Agent Skills documentation for the full catalog and tool requirements.

Google Workspace Integration

Connect Gmail, Google Calendar, and Google Drive in a few clicks. No complex setup needed. Your agents can manage your calendar, read and search emails, and access Drive files.

Easy Secure Sign-In

Setting it up is simple and secure:

  • Go to "Integrations" in your workspace settings
  • Create a connection for 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 sign-in to keep your data private.

Gmail Integration

Connect agents to Gmail so they can:

  • List and search emails
  • Read full email content and attachments
  • Use Gmail search filters
  • Support inbox management and follow-ups

Google Calendar Integration

Connect agents to Google Calendar to:

  • List events and search
  • Read event details
  • Create and update events
  • Delete events when needed
  • Support scheduling and meeting coordination

Google Drive Integration

Give agents access to files stored in Google Drive:

  • Read text files and documents
  • Access Google Docs (as plain text)
  • Read Google Sheets (as CSV)
  • Access Google Slides (as plain text)
  • Great for document review and data checks

Google Workspace integrations let agents work with your Google services. See the MCP Servers documentation for setup details.

Notion Integration

Connect Notion in a few clicks. Your agents can read and search pages, create and update content, and work with databases.

Easy Secure Sign-In

Setting it up is simple and secure:

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

All connections use secure sign-in to keep your data private.

Page Management

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

  • Read pages, including properties and content
  • Search pages and databases
  • Create new pages with content
  • Update page properties and content
  • Add blocks like paragraphs, headings, and lists

Database Management

Agents can query and manage Notion databases:

  • Filter and sort records
  • Create new entries with properties
  • Update existing entries
  • Great for knowledge and project tracking

Notion integration helps agents work with your workspace for docs and knowledge bases. See the MCP Servers documentation for setup instructions.

Error Tracking

Conversations are saved and errors are shown when something fails, making issues easy to spot and fix.

  • Errors saved in conversations
  • Clear error messages
  • Provider details when available
  • Error badges for quick spotting
  • Full context when you open an error
  • History across conversations

Error tracking works automatically. When requests fail, errors show up right away.

Agent Delegation

Agents can pass tasks to other agents in the same workspace, so work gets shared.

  • How agent delegation works
  • Setting up multi-agent workflows
  • Sharing tasks and coordinating work
  • Specialized agent teams
  • Use cases for collaboration
  • Best practices for delegation

Agent delegation lets you build teams where each agent handles the part they’re best at.

Email Sending

Set up email access so agents can send emails from your workspace.

  • Setting up workspace email connections
  • Adding email authentication
  • Using email tools in agents
  • Email templates and formatting
  • Best practices for email replies

Chat Platform Bot Integration

Deploy your agents as Slack or Discord bots so people can chat with them directly. This is different from notification channels—bots are interactive and respond to messages.

Slack Bot Integration

Deploy agents as Slack bots that respond to mentions and direct messages.

  • Guided setup with an app manifest
  • Secure verification of requests
  • Fast updates while the agent responds
  • Support for mentions and direct messages
  • Managed from the Integrations page

See the Slack Integration guide for detailed setup instructions.

Discord Bot Integration

Deploy agents as Discord bots with slash command support.

  • Secure verification for interactions
  • Fast updates while the agent responds
  • Full support for Discord interactions
  • Slash command support
  • Managed from the Integrations page

See the Discord Integration guide for detailed setup instructions.

Key Features

  • Unified Management: Manage all integrations from one place
  • Secure by Default: Verification ensures only valid requests are processed
  • Easy Setup: Step-by-step guides for both platforms
  • Fast Updates: Replies update as the agent works
  • Full Agent Capabilities: Bots can use the agent’s tools and memory

Chat bots let your agents respond to messages in Slack and Discord in real time.

Notification Channels

Set up notification channels so agents can send updates to Discord and Slack. This is different from bots—notifications are one-way alerts, while bots can chat back.

Discord Integration

Create a Discord channel connection so agents can send updates to it.

  • Set up a bot token
  • Add the channel ID
  • Test the connection

Slack Integration

Set up Slack webhooks so agents can post updates to channels.

  • Set up Slack webhooks
  • Connect via the API
  • Choose channels

Notification channels are great for alerts and automated updates.

Billing & Pricing

A simple overview of how Helpmaton pricing works.

What's Included in Your Subscription

Your monthly subscription covers the Helpmaton platform:

  • Hosting and infrastructure
  • Agent setup and management
  • Agent memory and usage tracking
  • 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 options:

  • Use your own API keys: Pay providers directly
  • Purchase credits: Buy credits through Helpmaton for pay-as-you-go billing

Cost Control & Spending Limits

Set spending limits to stay on budget:

  • Daily, monthly, or yearly spending limits
  • Limits for workspaces and agents
  • Automatic credit holds for accuracy

This keeps platform costs predictable while giving you flexibility on AI provider costs.

API Reference (For Developers)

For developers who want to integrate Helpmaton. Full API docs with examples and snippets.

OpenAPI Documentation

Full API documentation is available in OpenAPI format. Explore endpoints and request/response details.

Flexible Authentication

Multiple sign-in options: web sessions, API tokens, workspace API keys, and secure sign-in (OAuth).

Comprehensive API Coverage

Programmatic access to platform features including:

  • Workspace and agent management
  • Document upload and organization
  • Error tracking and conversation history
  • Usage analytics
  • Notification channel setup
  • Integration management
  • Webhook endpoints
View API Reference →

Self-Hosting

Helpmaton is source-available on GitHub, so you can run your own instance and customize it if you want.

License: Business Source License 1.1 (Apache 2.0 on 2029-11-01).

  • 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 can help.

Contact Us Join Discord