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: OpenAI Integration Example - Chat Completions API
Figure 2: OpenAI Integration Example - 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 engineeringarrow-up-right.

  • API Key - Your OpenAI API key, find the secret API key on the OpenAI Platform's API key pagearrow-up-right.

  • Model - The OpenAI model of your choice, you can get the overview of the models on the Models pagearrow-up-right of OpenAI Platform documentation.

For more information, you can explore the official OpenAI Platformarrow-up-right documentation.

Last updated

Was this helpful?