OpenAI Connection
Overview
The OpenAI connection allows IB-X Agents to connect to OpenAI services using customer-managed OpenAI credentials.
Use this connection when your organization manages its own OpenAI account, API credentials, and usage.
Configuring an OpenAI connection is optional when using supported OpenAI services through the IntelliBuddies Integration Gateway.
Connection Options
OpenAI services can be accessed in IB-X using either:
- Native OpenAI Key – Connect directly to OpenAI using a customer-managed OpenAI API key.
- Integration Gateway – Access supported OpenAI services through the IntelliBuddies Integration Gateway without configuring your own OpenAI API key.
Native OpenAI Key
Use Native OpenAI Key when your organization manages its own OpenAI account and API credentials.
IB-X uses the configured API key to authenticate directly with OpenAI.
Connection Properties
Configure the following property when creating a native OpenAI connection.
| Property | Description |
|---|---|
| API Key | API key associated with your OpenAI account. |
The API Key is a sensitive credential.
Protect the key from unauthorized access and manage it according to your organization's credential-management and security policies.
Integration Gateway
Instead of configuring a customer-managed OpenAI API key, supported OpenAI services can be accessed through the IntelliBuddies Integration Gateway.
When using the Integration Gateway:
- A customer-managed OpenAI connection is not required.
- OpenAI provider credentials do not need to be configured in IB-X.
- Requests are routed through the IntelliBuddies Integration Gateway.
- Usage consumes IB-X Currency.
The OpenAI services and models available through the Integration Gateway depend on the capabilities supported by IB-X.
Testing the Connection
After providing the required OpenAI API key, click Test Connection to verify that IB-X can authenticate with OpenAI using the supplied credentials.
Connection or authentication issues can result from:
- An invalid API key
- An expired or revoked API key
- Network connectivity problems
- Provider authentication failures
A successful connection test verifies that IB-X can authenticate with OpenAI using the configured credentials. Access to individual models and capabilities can depend on the OpenAI account and services available to the configured API key.
Used By
The OpenAI connection can be used by IB-X AI activities and capabilities that support OpenAI as an AI provider.
The models and capabilities available depend on the OpenAI services supported by the corresponding IB-X activity.
Security Considerations
When configuring an OpenAI connection:
- Protect the API Key from unauthorized access.
- Use credentials associated with the appropriate OpenAI account and IB-X environment.
- Restrict access to connection management based on organizational requirements.
- Rotate OpenAI API keys according to your organization's security policies.
- Do not expose API keys in Agent instructions, documentation, screenshots, or other unsecured locations.
When using OpenAI services through the Integration Gateway, customer-managed OpenAI credentials do not need to be configured in IB-X.
Additional Resources
For additional information about configuring and using OpenAI with IB-X, see Connecting to OpenAI.
For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.