BYO Azure OpenAI provider integration how to?
# support
j
Hi there I couldn't find any information or documentation on Vapi website that explains the correct structure or information needed to be provided into the URL. I have tried 2 approaches and both are not working. Approach 1: As my Azure OpenAI deployment is through 'Azure OpenAI services' I tried to provide the endpoint URL and the API key only, leaving the OCP-APIM-Subscription-Key-Header empty. - https://vapi-east-us-llm-resource.openai.azure.com/openai/deployments/gpt-4o-2024-11-20/chat/completions?api-version=2025-01-01-preview - See screenshot and error message. (error message is that 'resource cannot be found') Note that I have validated the endpoint and API key via cURL request and it was successful. Approach 2: I followed your your documentation outlink to Azure that suggested I should expose my API endpoint through an Azure API management instance - through this method I would need to provide an APIM subscription key (OCP-APIM-Subscription-Key Header). - https://vapi-east-us-llm-resource.azure-api.net/azure-openai-vapi/deployments/gpt-4o-2024-11-20/chat/completions?api-version=2025-01-01-preview - see screenshot and error message. (error message is that 'resource not found') Note that I have validated the endpoint and OCP-APIM-Subscription-Key Header key via cURL request and it was successful. Can you please share how the URL should be structured or what I am inputting correctly? The endpoints and credentials are working as expected when making cURL requests. https://cdn.discordapp.com/attachments/1376114496090673173/1376114496703303690/image.png?ex=683425fe&is=6832d47e&hm=7757c2233ba36ff283e5bac6fb74de768f03391f30e8c08e648f29e9d8890b59& https://cdn.discordapp.com/attachments/1376114496090673173/1376114496967540746/image.png?ex=683425ff&is=6832d47f&hm=1ad28ab52077ccda631cae41c092ad9f420cf339b1a455e1f82c59edf649fd99&
v
Vapi supports BYO Azure OpenAI integration using either the API key or the
Ocp-Apim-Subscription-Key
for API Management, but the documentation does not specify the exact endpoint URL format required in the dashboard.
Since your credentials work via cURL but not in Vapi, it's likely that Vapi expects a specific endpoint structure or parameter. I recommend reaching out directly to [Vapi Support](support@vapi.ai) or their [Discord community](https://discord.com/invite/pUFNcf2WmH) for the precise URL format and troubleshooting steps for the "resource not found" error. This will ensure you get the most accurate and actionable guidance for your integration. Sources: - [Vapi Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Vapi Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys) - [Vapi Support](https://docs.vapi.ai/support)
To integrate your Azure OpenAI deployment with Vapi, use the following structure for your endpoint and credentials:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management proxy
Make sure the "Model" matches your Azure deployment name, and the endpoint does not include `/openai/deployments/...`—Vapi will handle the path internally. If using API Management, include the subscription key as described in the [changelog](https://docs.vapi.ai/changelog/2025/1/11). Sources: - [Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Changelog October 8, 2024](https://docs.vapi.ai/changelog/2024/10/8)
v
Message marked as helpful by @Jeremy L! 🎉
j
Thanks this response helped, this should have been in the documentation somewhere that Vapi automatically appends the rest of the URL/.
v
For BYO Azure OpenAI integration in Vapi, use this structure:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
Do not include
/openai/deployments/...
in the endpoint URL—Vapi appends this automatically.
[See changelog for details](https://docs.vapi.ai/changelog/2025/1/11). Sources: - [Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Changelog October 8, 2024](https://docs.vapi.ai/changelog/2024/10/8)
To integrate your Azure OpenAI deployment with Vapi, use this format:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
Do not include
/openai/deployments/...
in the endpoint URL—Vapi appends this automatically.
For more details, see the [Vapi changelog](https://docs.vapi.ai/changelog/2025/1/11). Sources: - [Vapi Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Vapi Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys)
k
Hey Jeremy, can you share your orgID?
j
Hey Shubham, what's the need for it?
v
For BYO Azure OpenAI integration in Vapi, use this format:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
Do not include
/openai/deployments/...
in the endpoint URL—Vapi appends this automatically.
[See changelog for details](https://docs.vapi.ai/changelog/2025/1/11). Sources: - [Vapi Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Vapi Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys)
k
Jeremy, it is to look into your account what credentials are assosicated with your account adn what's happening over there.
j
Thanks, it's all good - the ai bots response actually gave me the information I was after to put in the right endpoint details. It's all working now. 🙂
Copy code
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
v
I'm glad to hear everything is working now! If you have any more questions in the future, feel free to ask. Great job getting your integration set up!
I'm glad to hear everything is working now! If you have any more questions in the future, feel free to ask. Great job getting your integration set up!
That's great to hear! I'm glad the information helped you get everything working smoothly. If you have any more questions in the future, feel free to ask. 😊
That's great to hear! I'm glad the information helped you get everything working smoothly. If you have any more questions in the future, feel free to ask. 😊
j
☝️ that should be available somewhere in your public documentation, would save many people hours of trial and testing.
v
That's a really helpful suggestion! Clear and accessible documentation can make a big difference for users setting up integrations, and your feedback highlights an area where things could be even smoother for everyone.
That's a really helpful suggestion! Clear and accessible documentation can make a big difference for users setting up integrations, and your feedback highlights an area where things could be even smoother for everyone.
Thank you for your feedback! The correct Azure OpenAI integration format for Vapi is:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
Do not include
/openai/deployments/...
in the endpoint URL—Vapi appends this automatically.
This is documented in the [Vapi Changelog](https://docs.vapi.ai/changelog/2025/1/11) and [Provider Keys guide](https://docs.vapi.ai/customization/provider-keys). Your suggestion to make this more prominent is valuable and will help others! Sources: - [Vapi Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Vapi Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys)
Thank you for your feedback! The correct Azure OpenAI integration format for Vapi is:
Copy code
plaintext
Endpoint URL: https://<your-resource-name>.openai.azure.com/
Model: <your-deployment-name>
API Key: <your-azure-openai-api-key>
(Optional) Ocp-Apim-Subscription-Key: <your-apim-subscription-key>  # Only if using API Management
Do not include
/openai/deployments/...
in the endpoint URL—Vapi appends this automatically.
This is documented in the [Vapi Changelog](https://docs.vapi.ai/changelog/2025/1/11) and [Provider Keys guide](https://docs.vapi.ai/customization/provider-keys). Your suggestion to make this more prominent is valuable and will help others! Sources: - [Vapi Changelog January 11, 2025](https://docs.vapi.ai/changelog/2025/1/11) - [Vapi Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys)