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 LLM 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 AgentQ Configuration dialog. Use this reference to understand what each field expects before going through them:
| FIELD | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| Provider | Option | Select Qualytics (Beta) or a supported external provider. When it is available, Qualytics sits at the top of the list above a divider that separates it from the external providers, and it is already selected when you open a new configuration. | |
| Model | Option / Text | External providers only; hidden for the Qualytics provider. Choose an available model or type a custom model name when the provider supports it. | |
| API Key | Text | Enter the credential required by the selected provider. Hidden for the Qualytics provider and for provider authentication methods that do not use an API key. | |
| Base URL | Text | External providers only; hidden for the Qualytics provider. Provide a custom endpoint for a compatible provider, such as Ollama, OpenRouter, or LiteLLM. | |
| Business Context | Text | Describe your organization's data quality focus, responsibilities, and domain. AgentQ uses this context to make its suggestions and answers more relevant to your organization. Up to 2000 characters. | |
| Provider-specific fields | Text / Option | Shown only when the selected provider or authentication method needs them. Azure OpenAI needs an Azure OpenAI Endpoint and an API Version, Google Vertex AI needs a GCP Project ID and a GCP Location, Snowflake Cortex needs a Snowflake Account Identifier, and Amazon Bedrock needs an AWS Region plus whatever its selected Authentication Method calls for. See Amazon Bedrock Authentication for what each method expects. Save stays unavailable until the required fields are filled in. |
Amazon Bedrock supports an API key, AWS access keys, or an IAM role. IAM Role authentication can use the deployment's existing AWS identity or assume a target role, depending on whether Role ARN is blank.
The form displays a data-processing notice for whichever provider you select, naming who processes the data AgentQ sends. For Qualytics 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 saving the configuration.
Steps
The AgentQ Configuration dialog can be opened from two places, and both lead to the same form. The tabs below walk through each path from start to finish; pick the one that matches where you are in the app. Each field is described in the Field reference above.
Step 1: Click the Settings icon in the bottom-left sidebar. The Settings page opens on the Connections tab.
Step 2: Select the Integrations tab.
Step 3: Locate the AgentQ section. The Integrations page lists every integration available in Qualytics, grouped by category, and AgentQ sits at the top of the page with the AI Provider entry.
Step 4: Click Connect next to AI Provider. The AgentQ Configuration dialog opens.
Step 5: Select a provider from the Provider dropdown:
- On deployments where the managed provider is available, Qualytics sits pinned at the top of the list with a Beta badge beside it, above a divider that separates it from the external providers, and it is already selected when the dialog opens. If you expect it in the list and do not see it, check When the Qualytics Provider Is Not Listed.
- The external providers appear below the divider. Selecting one reveals the fields that provider needs.
Step 6: Complete the fields shown for your selection:
- With Qualytics selected, a Beta badge appears beside the Provider field and the form asks only for the Business Context. There is no Model, API Key, or Base URL to fill in.
- With an external provider selected, choose the Model, enter the API Key when the provider uses one, and complete any provider-specific fields along with the Business Context.
Review the data-processing notice shown for the selected provider before you save. Save stays unavailable until every required field is filled in.
Step 7: Click Save.
Info
Qualytics sends a minimal request to the selected provider to test the connection before storing the configuration. For an external provider, this test also validates the supplied credentials. If the test fails or the provider is unreachable, an error appears and the configuration is not saved.
Step 8: A confirmation message appears and the AI Provider entry shows a Connected badge with the name of the active provider. External providers also show the selected model; the Qualytics provider shows Managed and keeps its Beta badge.
Step 1: Click AgentQ in the left sidebar. While no provider is configured, the No LLM Integration Configured page appears.
Step 2: Click Configure LLM. You are redirected to Settings > Integrations.
Step 3: Locate the AgentQ section. The Integrations page lists every integration available in Qualytics, grouped by category, and AgentQ sits at the top of the page with the AI Provider entry.
Step 4: Click Connect next to AI Provider. The AgentQ Configuration dialog opens.
Step 5: Select a provider from the Provider dropdown:
- On deployments where the managed provider is available, Qualytics sits pinned at the top of the list with a Beta badge beside it, above a divider that separates it from the external providers, and it is already selected when the dialog opens. If you expect it in the list and do not see it, check When the Qualytics Provider Is Not Listed.
- The external providers appear below the divider. Selecting one reveals the fields that provider needs.
Step 6: Complete the fields shown for your selection:
- With Qualytics selected, a Beta badge appears beside the Provider field and the form asks only for the Business Context. There is no Model, API Key, or Base URL to fill in.
- With an external provider selected, choose the Model, enter the API Key when the provider uses one, and complete any provider-specific fields along with the Business Context.
Review the data-processing notice shown for the selected provider before you save. Save stays unavailable until every required field is filled in.
Step 7: Click Save.
Info
Qualytics sends a minimal request to the selected provider to test the connection before storing the configuration. For an external provider, this test also validates the supplied credentials. If the test fails or the provider is unreachable, an error appears and the configuration is not saved.
Step 8: A confirmation message appears and the AI Provider entry shows a Connected badge with the name of the active provider. External providers also show the selected model; the Qualytics provider shows Managed and keeps its Beta badge.
Once saved, AgentQ is ready to use. See AgentQ Overview for next steps.
How It Works
The AI provider configuration is a single, deployment-wide setting, not a per-user choice. A Manager or Admin selects the provider and completes any required credentials once. AgentQ then becomes available to users with the Member role or higher. Only one provider configuration is active at a time.
AgentQ uses the Business Context with each user's conversation context to make responses and suggestions more relevant to your organization's domain. Do not include secrets or information that your configured AI provider should not process.
Using Azure API Management (APIM) with Azure OpenAI
If you front your Azure OpenAI endpoint with Azure API Management (APIM), you can point the Azure OpenAI integration at the APIM gateway instead of the Azure OpenAI endpoint directly. APIM acts as an OpenAI-compatible proxy. Two configuration details have to line up.
1. Base URL
Enter the APIM Gateway URL host the same way you would a native Azure OpenAI endpoint. Use only the host, without a trailing /openai:
The Azure OpenAI client appends /openai/deployments/{deployment}/...?api-version=... on its own, so adding /openai yourself doubles the path and causes 404s. On the APIM side, the Azure OpenAI API should be imported with its URL suffix set to openai so the gateway path mirrors a native Azure OpenAI endpoint (an APIM admin setting, not entered in Qualytics).
2. API Key / header name
Use the APIM subscription key as the API Key. The Azure OpenAI client sends its credential in the api-key HTTP header, but APIM expects the subscription key in Ocp-Apim-Subscription-Key by default. In APIM, go to API → Settings → Subscription → Header name and change it from Ocp-Apim-Subscription-Key to api-key. After that change, the subscription key flows through in the header the client already uses, making it a clean drop-in.
Note
Confirm the deployment name and api-version match what's deployed behind APIM (the standard Azure OpenAI import passes these through). APIM handles authenticating to the real Azure OpenAI backend on its side, so the backend model credentials are never exposed to Qualytics.
For more detail, see the Azure API Management documentation on authenticating and authorizing to LLM APIs, importing an Azure OpenAI API, and subscriptions and custom header names.
What's Next?
Want to connect external AI clients like ChatGPT, Claude Desktop, Cursor, or VS Code directly to the Qualytics MCP server? See Connecting External AI Clients for step-by-step setup guides.