Add AgentQ Integration

AgentQ uses the AI provider configured for your deployment. You can select the Qualytics-managed provider (Beta) without supplying a separate model or API key, or connect a supported external provider with your organization's credentials. This guide covers both options. For the full list of providers you can connect and the models each one offers, see Supported AI Providers.

Prerequisites

• A Qualytics account with the Manager or Admin role. The AI provider configuration is a deployment-wide setting, so no team permission is involved.
• If you choose an external provider, the credentials and provider-specific configuration it requires.

Field reference

The steps below open the Set up AgentQ page. Its General tab holds a Connection section, where you pick one of two setup paths, and a Business Context section that both paths share. What the Connection section asks for depends on the path you pick.

The page displays a data-processing notice for whichever path you select, naming who processes the data AgentQ sends. For Easy setup the notice explains that the data is processed on Amazon Web Services (AWS), which acts as a data processor; for an external provider it names that provider and points to its own data use and privacy policies. Review the notice and your organization's data-handling requirements before connecting.

Steps

Step 1: Click AgentQ in the left sidebar.

Step 2: At the bottom of the AgentQ sidebar, under Manage, click Settings . Beside the Manage label, a status dot and the provider name, or Not connected, show the current state. The Settings entry appears only for the Manager and Admin roles. While no provider is connected, the page is titled Set up AgentQ with a Not connected pill, and opens on the General tab.

Step 3: Under Connection, pick a path. Easy setup reads Runs on Qualytics AI. and Custom setup reads Bring your own provider, model, and key.

Step 4: Fill in the required fields for the path you picked and write the Business Context. The Field reference above lists what each path asks for. Review the data-processing notice shown below the form.

Step 5: Click Continue. Until the tab is complete, the hint above the buttons reads Finish the Connection tab to continue. The page moves to the Access Control tab. Back returns to General.

Step 6: Pick how much of your data AgentQ may share with the provider. The default is Source data shared, which turns everything on. Each level lists the capabilities it adds, shown as the screens they appear in. See Configure Access Controls for what each level means.

Step 7: Click Connect AgentQ. The hint above it reads Nothing is sent to a provider until you connect. Discard drops everything you entered instead.

Step 8: The toast AgentQ is connected appears and you land on the chat. Under Manage, the status dot turns green beside the provider's name, Qualytics AI for Easy setup, and the Audit entry appears for Admins. The AgentQ row on Settings > Integrations now shows the provider with a Connected badge and an Open AgentQ button.

Once connected, AgentQ is ready to use. See AgentQ Overview for next steps.

Using an Apigee-Fronted or Header-Gated Gateway

Many organizations reach their language models through an internal API gateway. The gateway speaks the OpenAI chat completions API, so the OpenAI provider with a custom Base URL already knows how to talk to it, but the gateway only accepts requests that carry its own headers, a bearer token issued by Apigee, or both. The settings below cover this, with custom headers and Apigee authentication available for every OpenAI-compatible provider and for Azure OpenAI. They are not tied to a particular gateway.

1. Provider, Model, Base URL and API Style

Under Custom setup, select OpenAI. This recipe uses the OpenAI provider on purpose: it accepts any model name the gateway exposes, and it is the one provider whose API style you can choose. Other OpenAI-compatible providers use their own default endpoints and API styles; this recipe assumes the selectable API style of the OpenAI provider. Type the model name supplied by your gateway into the Model field. You do not need to select an example or press Enter to keep it. Any name is accepted here; whether the gateway accepts it is checked when you save. Enter the gateway endpoint as the Base URL up to and including the version segment. The client appends the API path on its own:

https://<your-gateway-host>/<path-to-the-api>/v1

Set API Style to Chat Completions API; the OpenAI provider otherwise uses OpenAI's Responses API, which a gateway that serves only /chat/completions answers with a 404. If the gateway fronts models other than OpenAI's and rejects the max_completion_tokens field, also set Token Limit Parameter to max_tokens.

2. Authentication Method

Leave API Key selected when the gateway takes a static key in the Authorization header. Select Apigee OAuth 2.0 (client credentials) when the gateway expects a token minted by Apigee. The form then asks for:

Qualytics requests a token with the client credentials grant, sends it as Authorization: Bearer on every model call, and requests a new one shortly before it expires. If the gateway rejects a token as expired, Qualytics requests a fresh one and retries the call once.

3. Custom request headers

Click Add header for each header the gateway requires and enter its name and value. Turn on Secret for a header whose value is a credential, such as a gateway API key: its value is stored encrypted, is never shown again, and stays in place when you edit the configuration later unless you type a new one.

A value can contain placeholders that Qualytics fills in on every request, which is how per-request tracing headers are configured:

For example, a gateway that wants a client identifier, a secret key, a fresh request ID and a timestamp on every call would be configured as:

Headers the client sets itself, such as Authorization and Content-Type, cannot be overridden here.

For more detail on the Apigee side, see the Apigee documentation on the client credentials grant type and on requesting access tokens.