Documentation

How to use TicketBrain.ai

Everything you need to set up, configure, and get the most out of AI-powered ticket support.

Quick start

1. Create account → 2. Connect WHMCS API → 3. Add AI API key → Done! The AI starts processing tickets automatically within minutes.

Getting Started

Create your account
Sign up for a free 14-day trial. No credit card required.
Connect WHMCS
Enter your WHMCS API URL and credentials in the setup wizard. We'll verify the connection instantly.
Add AI API key
Provide your OpenAI, Anthropic, or other AI provider API key. The AI engine uses this to generate responses.
Start processing
Once setup is complete, the cron job automatically processes new tickets at your plan's interval.

Knowledge Base

Adding rules
Navigate to Knowledge Base in the dashboard. Click 'Add rule' and enter a category, rule text, and priority.
Categories
Organize rules by category (general, dns, email, billing, etc.). The AI filters rules by relevance.
Priority levels
Priority 1-10 (10 = highest). Higher priority rules take precedence when multiple rules apply.
Best practices
Be specific. Include server names, IPs, procedures. The AI uses rules as authoritative knowledge.

AI Configuration

Choosing a model
Available models depend on your plan. Each model has different strengths in speed, accuracy, and reasoning.
Feedback loop
Correct AI suggestions on the Tickets page. The AI learns from corrections for similar future tickets.
Image analysis
Pro+ plans can process screenshot attachments. The AI reads error messages and configuration details.
Multi-model routing
Enterprise plans use intelligent routing: the system picks the best model per ticket based on complexity.

API Integration

Creating API keys
Go to API Keys in the dashboard. Keys use the format tp_live_<random>. Store securely after creation.
Authentication
Include your API key in the Authorization header: 'Bearer tp_live_...' for all API requests.
Engine endpoints
/api/engine/status (GET) returns processing status. /api/engine/trigger (POST) manually triggers processing.
Rate limits
API calls are rate-limited per plan: Starter 30/min, Pro 60/min, Business 120/min, Enterprise 300/min.

Billing & Plans

Free trial
14-day trial with full Starter features. Continues as free plan after trial (50 tickets/month).
Upgrading
Upgrade anytime from the Billing page. Changes take effect immediately with prorated billing.
Downgrading
Downgrade via the Stripe billing portal. Takes effect at the end of your current billing period.
Ticket limits
When you hit your monthly limit, the AI pauses. Counter resets on your billing date.
WHMCS API Setup Guide
How to find your WHMCS API credentials

1. Log into your WHMCS admin panel

Go to Setup > Staff Management > Manage API Credentials

2. Create new API credential

Click "Generate New API Credential". Give it a description like "TicketBrain AI".

3. Set permissions

Enable: GetSupportStatuses, GetTickets, GetTicket, AddTicketNote, GetClientsDetails, GetClientsProducts.

4. Copy Identifier and Secret

Enter these in the TicketBrain setup wizard along with your WHMCS URL (e.g., https://client.yourhost.com/includes/api.php).

# Your WHMCS API URL format:

https://client.yourdomain.com/includes/api.php