Azure OpenAI

Selecting the Connection Type

Once you have selected your connection type, a configuration tab will appear on the next step, prompting you to input the required connection details.

Integration Setup

The integration supports two API types:

1. ​Chat Completions API - The traditional industry-standard protocol (/v1/chat/completions). It operates on a message-based array system and requires manual context management. While robust and widely used, it is now considered a legacy path and may not receive the latest agentic features or reasoning optimizations.

2. Responses API - The modern, unified protocol designed to supersede Chat Completions. It offers better performance with reasoning models (like GPT-5), native agentic loops for multi-tool calling, lower costs through improved cache utilization, and built-in stateful context management.

The setup process and requirements for both API Types are defined below.

Figure 1: Azure OpenAI - Chat Completions API

Figure 2: Azure OpenAI - Responses API

• System Prompt - Your application’s system prompt. It sets the initial instructions or context for the AI model, defines the behavior, tone, and specific guidelines the AI should follow while interacting. For best practices, refer to the OpenAI documentation on prompt engineering.

• API Key - In the Azure Portal, find a key on the Keys and Endpoint page of the Azure OpenAI resource.

• URL

  • Supported Azure OpenAI endpoints (protocol and hostname)

  • The general format for an endpoint is: https://{your-resource-name}.openai.azure.com.

  • For example: https://yourcompany.openai.azure.com

  • Endpoint is also found on the Keys and Endpoint page.

• Deployment Name - Configured when setting up your Azure OpenAI model. This is the unique identifier that links to your specific model deployment. Deployment names can be found on the Deployments section of your project on the Azure AI Foundry.

For more information, you can explore the official Azure OpenAI Service documentation.