Workflow

OpenAI Integration — Setup, access and model configuration

Activate the provider, store credentials and select the model and token settings used by core CRM AI features.

14 connected guidesLive filterPermission-aware instructions
14 guides
Guide

OpenAI Integration module overview

OpenAI Integration module overviewConnect the CRM AI-provider registry to OpenAI, configure the standard model and optionally use a CRM-trained fine-tuned model.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Install and activate OpenAI Integration v1.0.0

Install and activate OpenAI Integration v1.0.0Activate the bundled provider module and verify that its settings child appears under the CRM AI settings group.Admin Area → Setup → Modules → OpenAI Integration → Activate

Open guide →
Guide

Verify the CRM and PHP requirements for OpenAI Integration

Verify the CRM and PHP requirements for OpenAI IntegrationCheck the supplied version requirements before activation or upgrade.Server diagnostics and Admin Area → Setup → Modules → OpenAI Integration

Open guide →
Guide

Open the OpenAI settings workspace

Open the OpenAI settings workspaceUse the real settings path rather than looking for a standalone OpenAI menu.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Enter the OpenAI API key

Enter the OpenAI API keyStore the provider credential used to construct the OpenAI client.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Choose the standard OpenAI model

Choose the standard OpenAI modelSelect the model used when fine-tuning is disabled or no fine-tuned model is selected.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Set the OpenAI maximum token value

Set the OpenAI maximum token valueControl the max_tokens value sent with each chat request.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Configure the CRM AI system prompt

Configure the CRM AI system promptSet the parent CRM AI system instruction that OpenAI uses as the developer message and fine-tuning system message.Admin Area → Setup → Settings → AI

Open guide →
Guide

Save and verify OpenAI provider settings

Save and verify OpenAI provider settingsConfirm that the API key, model and maximum-token values persist and the provider is registered.Admin Area → Setup → Settings → AI → OpenAI

Open guide →
Guide

Use the OpenAI module action links

Use the OpenAI module action linksOpen either the provider-specific settings or the parent AI settings from the module list.Admin Area → Setup → Modules → OpenAI Integration → action links

Open guide →
Guide

Understand the OpenAI provider registry key

Understand the OpenAI provider registry keyKnow how the module becomes available to core CRM AI features.Code-backed reference → openai.php → openai_module_init

Open guide →
Guide

Extend the standard model list with the openai_models filter

Extend the standard model list with the openai_models filterAdd supported model entries without editing the provider class.Development integration → hook openai_models

Open guide →
Guide

Deactivate OpenAI Integration safely

Deactivate OpenAI Integration safelyDisable the provider module without assuming its stored options are deleted.Admin Area → Setup → Modules → OpenAI Integration → Deactivate

Open guide →
Guide

Troubleshoot a missing OpenAI settings section

Troubleshoot a missing OpenAI settings sectionCheck module activation, CRM version and parent AI settings registration when the child section is absent.Admin Area → Setup → Settings → AI → OpenAI

Open guide →