#
Provision PHOENIQS Chat
This guide covers provisioning a dedicated PHOENIQS Chat instance for your company: its own URL, its own databases, and your own sign-on.
If your company already runs a chat instance and you only want to start using it, you do not need this page. Go to the Quick Start instead.
#
Prerequisites
Before you begin, make sure you have:
- An active Phoeniqs Console account with permission to make purchases
- A company profile associated with your account
Everything must be in the same resource group
Every subscription lives in a resource group, which you choose at checkout. The provisioning dropdowns only list products from the same resource group: a chat instance in Project A cannot use a Base LLM API in Project B.
Choose your resource group before you start and select the same one at every checkout.
If you already have a fully provisioned Base LLM API in the resource group you want to use, skip to
#
Step 1: Purchase and provision a Base LLM API
PHOENIQS Chat runs on the Base LLM API. You need an active, fully provisioned Base LLM API in the same resource group before you can provision a chat instance. See Base LLM API for plans and pricing.
The MaaS Evaluation plan cannot run a PHOENIQS Chat instance
That plan is for testing the models directly through the API. When you provision a chat instance, the dropdown lists Base LLM API subscriptions only. If an Evaluation plan is all you have, there will be nothing to select.
Purchase a Base LLM API subscription, not an Evaluation plan.
- Sign in at https://console.phoeniqs.com.
- Open Products from the left navigation, or click Add Subscription from the Dashboard.
- Select AI Model Service, then choose Base LLM API.
- Click Add to cart, then Proceed to Checkout.
- Under Confirmation, select the Resource Group that will hold your chat instance. The new subscription is created in that resource group.
- Accept the terms and conditions, then click Buy subscription.
For the general checkout flow, see Buy a Subscription.
Then provision it:
- On the Order confirmed page, click Open resource groups, or navigate to Resource Groups in the left-hand menu.
- Open your resource group and click your Base LLM API subscription in its Subscriptions list. Its status is Ordered.
- Under Actions, click Provision service.
- Enter a subscription alias, a readable label you will see in later dropdowns, for example
MaaS-API-for-Finance-Team-Phoeniqs-Chat. - Click Provision.
Provisioning takes a few seconds. Wait until the subscription shows as provisioned before moving on; an unfinished subscription does not appear in the chat provisioning dropdown.
You do not need to create an API key yourself. The platform creates one on this Base LLM API and attaches it when you provision the chat instance in Step 3. With one subscription you can create as many API keys as you want and re-create them at any time.
#
Step 2: Purchase the PHOENIQS Chat subscription
- Open Products from the left navigation, or click Add Subscription from the Dashboard.
- Select PHOENIQS AI Platform, then choose Chat Dedicated. See Subscriptions for what the plan includes.
- Click Add to cart, then Proceed to Checkout.
- Under Confirmation, select the Resource Group that holds your Base LLM API.
- Accept the terms and conditions, then click Buy subscription.
The Order confirmed page lists the new subscription with status Ordered.
For the general checkout flow, see Buy a Subscription.
#
Step 3: Provision PHOENIQS Chat
- In Resource Groups, open the resource group holding your Base LLM API and click your Chat Dedicated subscription in its Subscriptions list.
- Under Actions, click Provision service.
- In the Provision service dialog, fill in:
- Subscription alias: a readable label you will use to identify this instance later.
- Data Pool Dedicated (optional): connects the chat to one of your company's Data Pool Dedicated. See Data Pools in PHOENIQS Chat.
- MaaS Instance (required): the Base LLM API from Step 1.
- Custom Hostname (optional): your own address for the chat, for example
chat.example.com. Leave it empty to use the generated address. SeeCustom hostname and DNS .
- Click Provision.
You never paste an API key
When you select a MaaS Instance, the platform creates a new API key on that Base LLM API, verifies that the key works, and attaches it to your chat instance automatically. There is no key to copy, and nothing to enter by hand.
Data Pool and hostname are fixed at provisioning
The Data Pool Dedicated and the Custom Hostname cannot be added or changed after the chat instance is provisioned. A Data Pool Dedicated cannot be cancelled while a chat instance is connected to it.
Provisioning normally takes 5 to 10 minutes. You can leave the page after starting it; the subscription status updates on its own.
#
Custom hostname and DNS
The optional Custom Hostname in Step 3 gives your chat instance your own address, for example chat.example.com, instead of the generated one.
- Use lowercase letters, digits, hyphens and dots, with at least one dot:
chat.example.com, notchat. - The hostname cannot be one that another chat instance already uses, or one under a PHOENIQS domain.
- To use a different hostname later, provision a new chat instance.
You must create a CNAME record for your hostname at your DNS provider. Contact support for the target to point it to. Create the record before you provision, or right after.
Once the record resolves, the TLS certificate for your hostname is issued automatically. Until then, the browser shows a certificate warning or an error when you open the instance.
Launch product opens your custom hostname. The generated address keeps working and reaches the same instance, behind the same sign-in.
Apex domains
DNS does not allow a CNAME on the zone apex (example.com itself). Use a subdomain such as chat.example.com, or an ALIAS or ANAME record with the same target if your DNS provider offers one.
#
Step 4: Open your instance
Once the subscription shows as provisioned, open it and click Launch product under Actions.
Your instance opens at its own URL and you sign in with your PHOENIQS account. Paid plans use enterprise SSO, so you sign in through your company identity provider rather than typing a password into the chat.
Sign in at least once before buying an assistant
Your chat user account is created the first time you sign in. A pre-built assistant purchased before you have ever signed in will not appear in your My Agents list.
#
What happens next
- Your chat instance draws inference from the credit pool of the Base LLM API you selected. All keys on that subscription share the same pool. See Base LLM API.
- To give colleagues access, add them as users of your company in the Phoeniqs Console, then share your instance URL with them. See Add Users to a Company.
- To increase the credit allowance, see How to add LLM Credits.
- Custom branding, your logo and theme, is set up by PHOENIQS on request. Contact support.
#
If provisioning fails
#
Removing a chat instance
Removing a chat instance deletes its data
Conversations, uploaded files and knowledge bases in that instance are destroyed and cannot be recovered. Export anything you need first.
A chat instance cannot be removed while pre-built assistants are still installed on it. Remove the assistants first, then the chat instance.
To remove a chat instance, open its subscription and click Deprovision under Actions. If Deletion protection is switched on, deprovisioning asks for an extra confirmation. Switch it on for chat instances in active use.
Removing a chat instance does not remove the API key it created on your Base LLM API. That key stays on the Base LLM API subscription and should be deleted separately if you no longer need it.
#
See also