# 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

If you already have a fully provisioned Base LLM API in the resource group you want to use, skip to Step 2.


# 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.

  1. Sign in at https://console.phoeniqs.com.
  2. Open Products from the left navigation, or click Add Subscription from the Dashboard.
  3. Select AI Model Service, then choose Base LLM API.
  4. Click Add to cart, then Proceed to Checkout.
  5. Under Confirmation, select the Resource Group that will hold your chat instance. The new subscription is created in that resource group.
  6. Accept the terms and conditions, then click Buy subscription.

For the general checkout flow, see Buy a Subscription.

Then provision it:

  1. On the Order confirmed page, click Open resource groups, or navigate to Resource Groups in the left-hand menu.
  2. Open your resource group and click your Base LLM API subscription in its Subscriptions list. Its status is Ordered.
  3. Under Actions, click Provision service.
  4. Enter a subscription alias, a readable label you will see in later dropdowns, for example MaaS-API-for-Finance-Team-Phoeniqs-Chat.
  5. Click Provision.
The Provision service dialog for Base LLM API
The Provision service dialog for Base LLM API

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

  1. Open Products from the left navigation, or click Add Subscription from the Dashboard.
  2. Select PHOENIQS AI Platform, then choose Chat Dedicated. See Subscriptions for what the plan includes.
  3. Click Add to cart, then Proceed to Checkout.
  4. Under Confirmation, select the Resource Group that holds your Base LLM API.
  5. Accept the terms and conditions, then click Buy subscription.
The Chat Dedicated plan in the Phoeniqs Console
The Chat Dedicated plan
Checkout: the Chat Dedicated plan and the resource group selection
Checkout: the Chat Dedicated plan and the resource group selection

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

  1. In Resource Groups, open the resource group holding your Base LLM API and click your Chat Dedicated subscription in its Subscriptions list.
  2. Under Actions, click Provision service.
  3. 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. See Custom hostname and DNS.
  4. Click Provision.
The Provision service dialog for Chat Dedicated
The Provision service dialog for Chat Dedicated

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, not chat.
  • 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.

Type Name Value
CNAME chat The target you received from support

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.


# Step 4: Open your instance

Once the subscription shows as provisioned, open it and click Launch product under Actions.

Actions of a provisioned Chat Dedicated subscription: Launch product, Move subscription and Deprovision
Actions of a provisioned Chat Dedicated subscription

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.


# 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

What you see What it means What to do
The MaaS Instance dropdown shows "No options are available" You have no provisioned Base LLM API in this resource group, or you only have an Evaluation plan Purchase and provision a Base LLM API first, or switch resource group
Your Base LLM API is missing from the dropdown It has not finished provisioning, or it sits in a different resource group Wait for provisioning to finish, or open the correct resource group
The Data Pool Dedicated dropdown is empty You have no provisioned Data Pool Dedicated in this resource group Leave it empty, or provision a Data Pool Dedicated in this resource group first
"The selected MaaS key is invalid" The Base LLM API behind it is not responding, or the subscription is not healthy Check the status dashboard, then retry
An error naming the custom hostname The hostname is not valid, sits under a PHOENIQS domain, or another chat instance already uses it Correct it, or choose another hostname
A certificate warning on your custom hostname The CNAME record is missing or does not resolve yet Check the record at your DNS provider. The certificate is issued once it resolves
Stuck in progress, then fails The instance could not be built Contact support with your subscription ID
Fails immediately The request was rejected The error message names the reason

# Removing a chat instance

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

Quick Start, your first conversation
../quick-start/
PHOENIQS Chat subscription plans
../subscriptions/
Model Service subscription plans
../../../maas/subscriptions/