Skip to content

OpenAI Setup

Use this integration only for the official OpenAI API.

Create an API key

  1. Open OpenAI API keys.
  2. Create a secret key with the permissions required by your account.
  3. Copy the key and store it securely.

Connect EspoCRM

  1. Open Administration > Integrations > AI » OpenAI.
  2. Enable the integration.
  3. Enter the API key.
  4. Click Test & Fetch Models.
  5. Select a model and test again to verify generation.
  6. Save.
  7. Open Administration > AI Settings > General and select OpenAI when it should be the default provider.

OpenAI integration

The model selector may show context limits, supported inputs, tool support, lifecycle status, and estimated pricing when catalog information is available.

Use AI » Custom for an OpenAI-compatible service with a different base URL.

Troubleshooting

  • Confirm the API key belongs to an active API project with available quota.
  • Choose a model returned by Test & Fetch Models.
  • Check AI Log for the failed request.
  • Provider capabilities vary by model. Use a tool-capable model for CRM-aware Chat and a compatible multimodal model for PDFs or images.