Overview
The hTech AI Ticket Assistant supports Bring Your Own Key (BYO) mode. This allows you to connect your own OpenAI API key and use your own OpenAI account for billing and usage. This guide explains how to request an OpenAI API key and how to install it inside the module.
Step 1: Create or Sign In to Your OpenAI Account
To request an API key, begin by signing into your OpenAI account.
- Visit https://platform.openai.com
- Sign in with your existing account, or create a new one if needed.
Step 2: Access the API Keys Page
Once logged in, open the API Keys section.
- Click your profile icon in the top right corner.
- Select "View API Keys" from the menu.
This will take you to a page where you can generate and manage your keys.
Step 3: Create a New API Key
To create a new key:
- Click the button labeled "Create new secret key".
- Give the key a name (optional, for your own reference).
- Copy the key immediately. OpenAI will only show it one time.
Store this key in a safe place. If you lose it, you must generate a new one.
Step 4: Enable Billing in OpenAI (If Required)
Some OpenAI models require an active billing method. If the key does not function, make sure that:
- Your OpenAI account has a valid billing method.
- You have not exceeded your monthly usage limit.
Step 5: Open the hTech AI Ticket Assistant Module
Log into your WHMCS admin area.
- Go to Addons.
- Click "hTech AI Ticket Assistant".
- Open the Settings tab.
Step 6: Switch to Bring Your Own Key Mode
Under AI Mode, select:
- Bring Your Own Key (BYO)
When this option is selected, the API Key field for OpenAI becomes available.
Step 7: Install Your OpenAI API Key
Paste your key into the field labeled:
- OpenAI API Key
Double-check for spaces or line breaks. The key must be pasted exactly as provided.
Click either "Test AI Connection" to verify and save, or click "Save Changes".
Step 8: Choose Your BYO Model
In the same settings screen, locate:
- Default Model (BYO)
Select the model you wish to use. Most users choose gpt-4o or higher.
Step 9: Test Your Configuration
Create a test ticket in your WHMCS environment and allow the assistant to process it. If the key is correct and billing is active, the reply will generate normally.
If no reply is generated, verify:
- Your key is active in OpenAI.
- You have not reached your spending limit.
- AI Mode is set to BYO.
- The model you selected is supported by your key.
Summary
Once your OpenAI API key is installed, the hTech AI Ticket Assistant will begin using your OpenAI account for all AI requests. This gives you full control over usage, limits, and billing.
If you need help configuring your OpenAI API key, feel free to open a support ticket.