How to include Api Subscription key of Custom Question Answer in Azure Bot Service Web App

Question

How to include Api Subscription key of Custom Question Answer in Azure Bot Service Web App

Sonali Vaghela 20

In Azure AI Bot Service, I have added Custom Question Answer Service Endpoint to the Bot Service Message Endpoint.
But I am unable to find where to add subscription key to the bot.

Also, Direct link to create a bot from Custom Question Answer deployment not working.
Any suggestions?

Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-06T04:04:03.6833333+00:00
Hi Sonali Vaghela,

Welcome to Microsoft Q&A forum. Thanks for posting your query.

Since your bot is calling the Custom Question Answering (part of Azure AI Search & Language Services), it needs an API key for authentication. The API key should be added to the request headers. Follow these steps:

Option 1: Add Subscription Key in Bot Code (If You Have Code Access)

If you have access to your bot’s code (in a Bot Framework SDK or Web App Bot), include the API key in the HTTP request headers:

import requests API_ENDPOINT = "https://<your-custom-question-answer-endpoint>/language/:query-knowledgebases" SUBSCRIPTION_KEY = "your-subscription-key" headers = { "Ocp-Apim-Subscription-Key": SUBSCRIPTION_KEY, "Content-Type": "application/json" } data = { "question": "your question", "top": 3 } response = requests.post(API_ENDPOINT, headers=headers, json=data) print(response.json())

Replace <your-custom-question-answer-endpoint> with your actual Azure Custom Question Answering endpoint.

Option 2: Add API Key in Azure Bot Configuration (If No Code Access):

If you are using Azure Bot Service without direct code access, follow these steps:

Go to Azure Bot Service:

Open Azure Portal → Navigate to Bot Services → Select your bot.

Set the API Key as an Application Setting:

Go to Configuration in your bot's App Service.

Under Application settings, click New application setting.

Add:

Name: QNA_SUBSCRIPTION_KEY

Value: your-subscription-key

Click Save.

Modify Bot Service Endpoint (if required):

Open Bot Service → Settings → Messaging Endpoint.

If using a proxy, ensure it forwards the Ocp-Apim-Subscription-Key header.

Direct Link to Create a Bot from Custom Question Answer Not Working:

If the direct link is not working, try the manual approach:

Step 1: Deploy a Custom Question Answering Service

Go to Azure AI Services.

Search for Language Services → Create a Custom Question Answering (CQA) resource.

Note the endpoint URL and API key (found in Keys & Endpoint).

Step 2: Create a New Bot Manually

In Azure Portal, go to Bot Services → Click Create.

Choose Web App Bot or Bot Framework SDK.

Under Cognitive Services, add the Custom Question Answering endpoint manually.

Final Checks:

Verify that the subscription key is valid from Azure Cognitive Services → Keys & Endpoints.

Use Postman to check if your API is responding correctly.

Check Bot Logs (Application Insights) for request failures.

Hope this helps. Do let us know if you any further queries.

-------------

If this answers your query, do click Accept Answer and Yes for was this answer helpful.

Thank you.
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-07T02:21:14.2066667+00:00

Hi Sonali Vaghela,

Following up to see if the above answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
Sonali Vaghela 20 Reputation points

2025-03-07T07:04:02.9233333+00:00

Hi @Prashanth Veeragoni

Thanks for your reply.
Currently I am not creating bot from code. I am using Azure AI Bot service.

In the creation, I have already entered the My Custom question answer message endpoint. But I am unable to find where to enter it's subscription key.

I have already tested the APIs of custom QnA in postman and it's working fine.

There is no application setting thing that you have suggested.

I have gone through below steps to create bot.

Go to Azure Bot -> Create New -> Type of App (Multi Tenant) -> Review & Create

After creating in the configuration section, I am writing message endpoint.
While clicking on "Test in Web Chat", it is throwing "Unauthorized" error.

Am I doing anything wrong in that?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-10T01:57:11.68+00:00

Hi Sonali Vaghela,

The "Unauthorized" error in Web Chat indicates that your Azure AI Bot Service is not passing the subscription key when calling the Custom Question Answering (CQA) service. This happens because Azure Bot Service does not automatically include API keys in outbound requests.

Since you created the bot using Azure Bot Service (without code access), you need to configure authentication properly.

Steps to Fix Unauthorized Error:

Go to Azure Portal → Navigate to Azure Bot Services.

Click on your bot → Open Configuration.

Locate Messaging Endpoint (where you have already added your CQA endpoint).

Modify the Messaging Endpoint URL to include the subscription key as shown below:

Code

Click Save and Restart the bot.

Now, Test in Web Chat again.

Why this Works? Azure AI Bot Service will now pass the API key in the URL, allowing the CQA service to authenticate the request.

If Adding the Key in Messaging Endpoint Doesn't Work

If you still get an Unauthorized error, try this alternate method:

Use Azure API Management as a Proxy:

If your bot cannot modify headers directly, you can use Azure API Management to attach the key.

Steps:

Create an API Management Service in Azure.

Create a new API that routes requests to your CQA endpoint.

Configure API Management to automatically include the Ocp-Apim-Subscription-Key header.

Change the Messaging Endpoint in your bot to point to your API Management proxy instead of the direct CQA endpoint.

This ensures every request from your bot includes the subscription key.

Try the Messaging Endpoint modification first and let me know if the Unauthorized error disappears.

Hope this helps. Do let us know if you any further queries.

-------------

If this answers your query, do click Accept Answer and Yes for was this answer helpful.

Thank you.
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-11T01:02:34.2533333+00:00

Hi Sonali Vaghela,

Following up to see if the below suggestion was helpful. And, if you have any further query do let us know.

Thank you.
Sonali Vaghela 20 Reputation points

2025-03-11T05:10:33.9833333+00:00

Hi @Prashanth Veeragoni
I am unable to see the first step code that you have mentioned in the line below.
Modify the Messaging Endpoint URL to include the subscription key as shown below:
Can you please re-write it one more time?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-11T06:31:31.28+00:00
Hi Sonali Vaghela,

Please try below code as follows and try,

https://<your-custom-question-answer-endpoint>/language/query-knowledgebases?subscription-key=<Your-API-Key>

If you still get an Unauthorized error, try alternate method which I mentioned in the previous response

Please let me know if you still face any issues.

Thank you.
Sonali Vaghela 20 Reputation points

2025-03-11T08:54:29.8233333+00:00

Hi @Prashanth Veeragoni ,

I have tried your first solution. It is not working.
Can you please elaborate steps for your second solution in detail?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-12T09:09:51.3466667+00:00

Hi Sonali Vaghela,

Please refer document: https://learn.microsoft.com/en-us/azure/ai-services/language-service/question-answering/tutorials/bot-service#create-a-bot

For Azure OpenAI (Custom Question Answer), you should use the Resource Key when making API calls.

Which will help you in solving the issue.

Thank You.
Sonali Vaghela 20 Reputation points

2025-03-12T12:36:23.0533333+00:00

Hi @Prashanth Veeragoni ,

I have already tried this solution.
As you can see, I have also mentioned in my problem that "Create a bot" link is not working.
Goes into infinite loop. I have waited 4-5 hours but that bot is not created from the link.

Is there any other solution?

Thanks.

Accepted answer

0 additional answers

Your answer

Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-07T02:21:14.2066667+00:00

Hi Sonali Vaghela,

Following up to see if the above answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
Sonali Vaghela 20 Reputation points

2025-03-07T07:04:02.9233333+00:00

Hi @Prashanth Veeragoni

Thanks for your reply.
Currently I am not creating bot from code. I am using Azure AI Bot service.

In the creation, I have already entered the My Custom question answer message endpoint. But I am unable to find where to enter it's subscription key.

I have already tested the APIs of custom QnA in postman and it's working fine.

There is no application setting thing that you have suggested.

I have gone through below steps to create bot.

Go to Azure Bot -> Create New -> Type of App (Multi Tenant) -> Review & Create

After creating in the configuration section, I am writing message endpoint.
While clicking on "Test in Web Chat", it is throwing "Unauthorized" error.

Am I doing anything wrong in that?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-10T01:57:11.68+00:00

Hi Sonali Vaghela,

The "Unauthorized" error in Web Chat indicates that your Azure AI Bot Service is not passing the subscription key when calling the Custom Question Answering (CQA) service. This happens because Azure Bot Service does not automatically include API keys in outbound requests.

Since you created the bot using Azure Bot Service (without code access), you need to configure authentication properly.

Steps to Fix Unauthorized Error:

Go to Azure Portal → Navigate to Azure Bot Services.

Click on your bot → Open Configuration.

Locate Messaging Endpoint (where you have already added your CQA endpoint).

Modify the Messaging Endpoint URL to include the subscription key as shown below:

Code

Click Save and Restart the bot.

Now, Test in Web Chat again.

Why this Works? Azure AI Bot Service will now pass the API key in the URL, allowing the CQA service to authenticate the request.

If Adding the Key in Messaging Endpoint Doesn't Work

If you still get an Unauthorized error, try this alternate method:

Use Azure API Management as a Proxy:

If your bot cannot modify headers directly, you can use Azure API Management to attach the key.

Steps:

Create an API Management Service in Azure.

Create a new API that routes requests to your CQA endpoint.

Configure API Management to automatically include the Ocp-Apim-Subscription-Key header.

Change the Messaging Endpoint in your bot to point to your API Management proxy instead of the direct CQA endpoint.

This ensures every request from your bot includes the subscription key.

Try the Messaging Endpoint modification first and let me know if the Unauthorized error disappears.

Hope this helps. Do let us know if you any further queries.

-------------

If this answers your query, do click Accept Answer and Yes for was this answer helpful.

Thank you.
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-11T01:02:34.2533333+00:00

Hi Sonali Vaghela,

Following up to see if the below suggestion was helpful. And, if you have any further query do let us know.

Thank you.
Sonali Vaghela 20 Reputation points

2025-03-11T05:10:33.9833333+00:00

Hi @Prashanth Veeragoni
I am unable to see the first step code that you have mentioned in the line below.
Modify the Messaging Endpoint URL to include the subscription key as shown below:
Can you please re-write it one more time?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-11T06:31:31.28+00:00

Hi Sonali Vaghela,

Please try below code as follows and try,

https://<your-custom-question-answer-endpoint>/language/query-knowledgebases?subscription-key=<Your-API-Key>

If you still get an Unauthorized error, try alternate method which I mentioned in the previous response

Please let me know if you still face any issues.

Thank you.
Sonali Vaghela 20 Reputation points

2025-03-11T08:54:29.8233333+00:00

Hi @Prashanth Veeragoni ,

I have tried your first solution. It is not working.
Can you please elaborate steps for your second solution in detail?
Prashanth Veeragoni 4,930 Reputation points Microsoft External Staff Moderator

2025-03-12T09:09:51.3466667+00:00

Hi Sonali Vaghela,

Please refer document: https://learn.microsoft.com/en-us/azure/ai-services/language-service/question-answering/tutorials/bot-service#create-a-bot

For Azure OpenAI (Custom Question Answer), you should use the Resource Key when making API calls.

Which will help you in solving the issue.

Thank You.
Sonali Vaghela 20 Reputation points

2025-03-12T12:36:23.0533333+00:00

Hi @Prashanth Veeragoni ,

I have already tried this solution.
As you can see, I have also mentioned in my problem that "Create a bot" link is not working.
Goes into infinite loop. I have waited 4-5 hours but that bot is not created from the link.

Is there any other solution?

Thanks.

Answer 1

JAYA SHANKAR G S 4,035 Microsoft External Staff Moderator

Hi @Sonali Vaghela ,

Our product team is working on this issue.

As a workaround you can follow below steps.

In Deployment page, fill all the required details and go back to Basics tab(step 1).

enter image description here

Click on Edit Template and download the file

enter image description here

Next, again in Basics tab click on Edit parameters and download the file.

enter image description here

After downloading template and parameters file go to Custom template link and click on "Build you own template in the editor".

Here, you load the template file and click on save.

enter image description here

then click on Edit parameters and load the parameter file, save it.

enter image description here

Now you can see some parameters are pre-filled, select the resource group and deploy it.

Once it's deployed you can test it from webchat and let me know if you have any query.

If above solution works for you, please do accept the solution and give feedback clicking on yes

Thank you

JAYA SHANKAR G S 4,035 Reputation points Microsoft External Staff Moderator

2025-03-14T03:55:15.11+00:00

Hi @Sonali Vaghela ,

Checking if the workaround helped you or not, let me know if you have any query.

Thank you
JAYA SHANKAR G S 4,035 Reputation points Microsoft External Staff Moderator

2025-03-17T03:38:56.2366667+00:00

Hi @Sonali Vaghela ,

Hope the workaround helped you.

Please do accept the solution and give feedback by clicking on yes.

Thank you
Sonali Vaghela 20 Reputation points

2025-03-17T08:57:05.83+00:00

Hi @JAYA SHANKAR G S ,

That solution solve my issue. I hope your product solve that other side issue ASAP.
Thank you for your help.
Sonali Vaghela 20 Reputation points

2025-03-17T08:57:40.7933333+00:00

Hi @JAYA SHANKAR G S ,

That solution solve my issue. I hope your product solve that other side issue ASAP.
Thank you for your help.

Share via

How to include Api Subscription key of Custom Question Answer in Azure Bot Service Web App

0 additional answers

Your answer