Documentation

Everything you need to get started with HireAI and make the most of your AI email agents.

Getting Started

Get your AI email agent up and running in 5 simple steps.

1

Create your account

Sign up with your email or Google account. No credit card required for the free trial.

2

Connect your Gmail

Click "Connect Gmail" on the dashboard and authorize HireAI via Google OAuth. We only request the permissions needed to read and send emails.

3

Choose your agent

Select an industry-specific agent (General, HR, Real Estate, or E-commerce) or start with the General agent.

4

Configure rules (optional)

Set up custom IF/THEN rules to automate specific workflows. For example: if an email contains "invoice", label it as Finance and forward to your accountant.

5

Activate your agent

Turn on your agent and it will start processing incoming emails immediately. Monitor its activity on the dashboard.

Connect Gmail

Follow these steps to securely connect your Gmail account.

Navigate to Settings

Go to your HireAI dashboard and click Settings in the sidebar.

Click Connect Gmail

In the Gmail Integration section, click the "Connect Gmail" button.

Authorize with Google

A Google OAuth popup will appear. Select your Gmail account and click "Allow" to grant HireAI access.

Verify Connection

Once connected, you will see a green "Connected" badge next to your email address. Your agent can now process emails.

Tip: If your Gmail token expires, go to Settings and click "Reconnect Gmail". Token refresh is usually handled automatically by our self-healing system.

How Agents Work

HireAI agents follow a four-step pipeline for every incoming email.

Receive
Classify
Generate Reply
Execute Rules

Email Classification

When a new email arrives, the agent analyzes the content and classifies it into categories like HR, Sales, Support, or custom categories you define.

Smart Reply Generation

Based on the classification and email context, the agent generates a professional reply. You can review it before sending or enable auto-send for trusted categories.

Rule Execution

Custom rules are evaluated in priority order. Actions include auto-reply, label, forward, escalate to WhatsApp, or archive.

Learning & Adaptation

When you edit or reject an AI-generated reply, the agent learns from your correction and improves future responses.

API Reference

Base URL: https://hireaidigitalworkforce-production.up.railway.app

All endpoints require an Authorization: Bearer <token> header (except signup and login).

POST/api/auth/signup

Create a new user account

{ "email": "string", "password": "string", "full_name": "string" }
POST/api/auth/login

Authenticate and receive a session token

{ "email": "string", "password": "string" }
GET/api/emails

Fetch processed emails with classification data

GET/api/analytics/overview

Get analytics dashboard data

POST/api/agent/start

Start the email processing agent

{ "agent_type": "general | hr | realestate | ecommerce" }
POST/api/agent/stop

Stop the email processing agent

GET/api/agent/status

Check current agent status and health

Frequently Asked Questions

Need more help?

Our support team is available to assist you with any questions or issues.