AI Connector BYOK

umarca_ai_gateway
Category Productivity/AI
Odoo 20.0
License OPL-1
Available for purchase
$300
Get it on the Odoo Apps Store, or request it directly.
Support: Support is by email at contact@umarca.com. Replies within 2 business days, Monday to Friday. Covered: help installing the module and adding your first providers, setup (included in the price), bugs in the module, and fixes when a provider that follows the OpenAI format does not work. Send the provider name, the model and the error text you see. Not covered: your provider's own outages, billing or rate limits, bugs in Odoo itself, custom development, and changes a provider makes to its API after release. These can be quoted separately.
Buy on Odoo Apps Store
Licensing, refunds and support - see the FAQ →

Summary

AI Connector BYOK lets you keep using the Odoo AI app with your own provider. Chat, agents, voice dictation, call transcripts, images, embeddings and web search go to the services you choose, with your own keys, instead of Odoo’s paid AI service.Nothing in the Odoo source is edited. The module extends the AI app with inherited models and a runtime patch of its two transport functions. It works with any OpenAI-compatible API, with your own ChatGPT account, and with Cloudflare Workers AI, whisper-api.com, OpenRouter and Voyage AI.

Features

✓
Use any OpenAI-compatible provider with your own API key (Chat Completions or Responses style)
✓
Sign in with your ChatGPT account instead of using an API keyChat only. Usage counts against your ChatGPT plan, and OpenAI offers this sign-in as a preview, so access can change on their side.
✓
Pick a provider for each job: chat, image generation, transcription and voice, embeddings
✓
Assign providers to users or groups, set a default, or pin a provider on a single agent
✓
Agents keep their tools: search and update records, build automations, read PDFs, look at images
✓
Web search through the provider's own search or a Brave key
✓
Built-in web page scraper that follows robots.txt and refuses private network addressesLoopback, link-local, private and reserved addresses are blocked, and the check is repeated on every redirect.
✓
Voice dictation in the chat, sent as short clips and typed after each pauseNot word-by-word streaming. Audio still buffered at the moment you press Stop is lost.
✓
Call recordings transcribed with timestamps
✓
Embeddings from any OpenAI-style endpoint, with vectors padded to the size Odoo storesOdoo stores 1536 numbers per vector. Smaller vectors are padded with zeros, larger ones are refused.
✓
Ready-made adapters for Cloudflare Workers AI (images) and whisper-api.com (speech to text)
✓
Fetch models button fills the model fields with a dropdown from the provider
✓
Provider errors shown to the person who asked, in a notification with the provider's own message
✓
API keys and ChatGPT tokens encrypted in the database, with the encryption key optionally kept in odoo.conf
✓
Max Output Tokens setting for providers that cut answers shortCloudflare Workers AI limits answers to 256 tokens unless told otherwise, which truncates tool calls. 4096 works well.

Installation

# Needs Odoo Enterprise with the AI app (ai_agentic) installed
# Install the Python packages on the Odoo server
1. pip install PyJWT markdown2==2.5.4
# Copy the umarca_ai_gateway folder into your addons path, then restart Odoo
# Optional but recommended: generate an encryption key for the stored provider keys
2. python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
# Add this line to the [options] section of odoo.conf, with the key you generated:
# umarca_ai_encryption_key = <your key>
# Install from Apps (update the apps list first), or from the command line:
3. odoo -d <your_database> -i umarca_ai_gateway --stop-after-init
# To update after a new version:
4. odoo -d <your_database> -u umarca_ai_gateway --stop-after-init

Configuration

Open AI > Configuration > Providers and click New.The menu is added by this module under the AI configuration menu. Only administrators can see it.

Add a provider

  1. Name the provider and choose its type: API key, or Sign in with ChatGPT.
  2. For an API key, enter the Base Url from the provider's documentation (usually ending in /v1) and the key.
  3. Choose the API style: Chat Completions for almost every provider, Responses for OpenAI.
  4. Under Use this provider for, tick Chat, Image generation, Transcription and voice, or Embeddings. Only the fields of the ticked uses appear.
  5. Click Fetch models to pick from a dropdown, or type the model names.Some providers have no model list. Then the fields stay as text boxes and you type the names.
  6. Under Assigned To, add users or groups, or tick Default Provider.
  7. To use a provider for one agent only, choose it in the AI Provider field of that agent.

How requests are routed

  • Each job (chat, images, transcription) goes to the provider assigned to the user, or to the default provider, that has that use ticked.
  • A job without a provider shows a clear message. The other jobs keep working.
  • Embeddings use the one provider that has Embeddings ticked.

Sign in with ChatGPT

  • Click Connect ChatGPT and approve in the new tab.
  • Copy the full address of the page you land on. It starts with http://127.0.0.1.
  • Paste it into the Finish sign-in box. No API key or client ID is needed.The landing page cannot be reached on a hosted server. That is expected. Pasting the address is what completes the sign-in. Your computer's clock must be correct, or OpenAI's token is rejected as not yet valid.

Cloudflare Workers AI

  • Base Url: https://api.cloudflare.com/client/v4/accounts/YOUR_ACCOUNT_ID/ai/v1
  • API Key: your Cloudflare API token
  • API style: Chat Completions
  • Chat model: for example @cf/openai/gpt-oss-120b
  • Max Output Tokens: 4096
  • Images: tick Image generation, set Image API to Cloudflare Workers AI, and use a model such as @cf/black-forest-labs/flux-2-klein-4b
  • Use the full model names.Some models are available only on a paid Cloudflare plan. The provider error notification shows Cloudflare's message when a model is refused.

whisper-api.com (speech to text)

  • Base Url: https://api.whisper-api.com
  • Tick Transcription and voice only
  • Transcription API: whisper-api.com
  • Model: tiny, base, small, medium or large-v3
  • Each clip takes a few seconds, because it is processed in the background.

Embeddings

  • Tick Embeddings on one provider and set its embedding model.
  • Only one provider can hold Embeddings.
  • Leave Send Dimensions off unless the provider is OpenAI and you use a text-embedding-3 model.Most other providers reject the dimensions parameter.

Encryption key (optional)

  • Set umarca_ai_encryption_key in odoo.conf, as shown in the installation steps.
  • On the next start the stored provider keys are re-encrypted under it and the old key is removed from the database.
  • Back the key up. Without it the saved keys cannot be decrypted and must be entered again.

Technical notes

The module edits no file of Odoo. It extends the AI models with inheritance and, when the server loads it, replaces two functions of the AI app (the connection lookup and the transport call) so requests go to your providers.The patch is installed once in post_load and skipped if it is already in place.

Chat requests that Odoo sends to its agent loop run in a background thread and are delivered to Odoo's own signed webhook. A lease and a one-minute scheduled action resubmit a request that was lost (up to 3 attempts, 60 second margin). The values are system parameters under umarca_ai_gateway.

Resolution order for each job (chat, image, transcription): the provider pinned on the agent, then a provider assigned to the user or one of the user's groups (lowest sequence first), then the default provider. Only providers with that use ticked are considered. Embeddings use the single provider that has Embeddings ticked. Public and website visitors never resolve to a ChatGPT sign-in provider.

Secrets use Fernet encryption. They are never sent to the browser, never logged, and not shown in the record history.

The web scraper runs inside Odoo, checks each address and each redirect against private, loopback, link-local and reserved ranges, and ignores proxy settings.

Known limits: the scraper takes no screenshots. A ChatGPT sign-in does chat only and cannot be the default provider. Odoo's own document search keeps only chunks with a cosine similarity of 0.9 or more, so a question worded very differently from the stored text can return no context with any provider. A few Odoo services outside the AI app, such as the Google Translate proxy, are not rerouted.

Python packages: PyJWT (ChatGPT sign-in) and markdown2 (formatting of AI answers; Odoo's tests expect version 2.5.4).

Changelog

  • Providers for chat, images, transcription and embeddings, each resolved separately
  • Assignment by user, group, default provider or agent pin
  • API-key providers (Chat Completions and Responses) and Sign in with ChatGPT
  • Adapters for Cloudflare Workers AI images and whisper-api.com speech to text
  • Fetch models, Max Output Tokens, Send Dimensions off by default
  • Web search, built-in scraper with network guard, PDF and image input
  • Voice dictation and call transcripts with timestamps
  • Encrypted provider secrets with an optional key in odoo.conf
  • Provider errors shown as a notification

Screenshots

Figure 1
Figure 1
Figure 2
Figure 2
Figure 3
Figure 3
Figure 4
Figure 4
Figure 5
Figure 5
Figure 6
Figure 6

Need this module, or one like it?

I build custom Odoo modules to fit the process rather than the other way round.