juhe-it-solutions / contao-openai-assistant
OpenAI Responses API integration for Contao CMS
Package info
github.com/juhe-it-solutions/contao-openai-assistant
Type:contao-bundle
pkg:composer/juhe-it-solutions/contao-openai-assistant
Requires
- php: ^8.2
- contao/core-bundle: ^5.3@dev
- symfony/http-client: ^6.4 || ^7.0
- symfony/rate-limiter: ^6.4 || ^7.0
Requires (Dev)
- contao/easy-coding-standard: ^6.13
- phpstan/phpstan: ^2.0
- phpunit/phpunit: ^10.5 || ^11.0
- symplify/easy-coding-standard: 13.2.3
README
OpenAI Responses API integration for Contao 5.3+. The extension adds a backend dashboard for OpenAI configuration, prompt setup and knowledge-base files, plus a configurable frontend AI chatbot module.
It uses OpenAI's Responses API and Conversations API at runtime. Knowledge-base files are uploaded to OpenAI vector stores and attached through File Search.
Upgrading from 1.x? Version 2.0 is a breaking change: the extension no longer calls the OpenAI Assistants API (
/v1/assistants,/v1/threads). Any OpenAI Assistants created by older versions are cleaned up from the OpenAI platform by a one-shot migration on upgrade. See the CHANGELOG and Upgrading from 1.x.
Requirements
- Contao 5.3 or newer
- PHP 8.2 or newer
- OpenAI API key with access to Responses, Conversations, Files and Vector Stores
Installation
Install with Contao Manager or Composer:
composer require juhe-it-solutions/contao-openai-assistant
Then run the Contao database migration. Detailed setup is documented in docs/installation.md.
Automatic Vector-Store Sync (Premium Add-On)
Keep your chatbot knowledge base up to date automatically.
The premium add-on can crawl selected Contao pages and update the OpenAI vector store from your website content. It supports manual or scheduled runs and requires a valid premium license.
Learn more in the premium add-on help pages.
Documentation
docs/README.md- documentation indexdocs/installation.md- installation and first setupdocs/configuration/openai-setup.md- OpenAI configurationdocs/configuration/prompts.md- prompt configurationdocs/development/troubleshooting.md- upgrade notes and common issues
License And Security
This extension is dual-licensed:
- Core extension (backend dashboard, prompts, knowledge-base files, frontend chatbot): LGPL-3.0-or-later, see
LICENSE. - Premium add-on (automatic vector-store sync and license validation; the files listed in
LICENSE-PREMIUM): proprietary. The files ship with the package, but using the premium features requires a valid premium subscription.
Versions tagged before the introduction of LICENSE-PREMIUM remain entirely under LGPL-3.0-or-later.
Please report security issues privately to office@juhe-it-solutions.at.