Setting up AVA with an OpenAI-compatible API new

You can connect Haiilo AVA to an AI provider that offers an OpenAI-compatible API. This option can be used, for example, if your organization uses a self-hosted LLM or an AI provider other than OpenAI or Microsoft Azure OpenAI that offers a compatible API.

An OpenAI-compatible API follows the common interface and request and response formats used by OpenAI's API. This allows applications built for this interface to interact with models from different providers or self-hosted deployments. Using an OpenAI-compatible API does not mean that you are using OpenAI or an OpenAI model.

Before setting up AVA

You need to have an AI provider or deployment that offers an OpenAI-compatible API.

Before setting up AVA, obtain the following information from your AI provider:

  • API key: The credential used to authenticate requests to your AI provider. Obtain the API key from your provider. The format of the API key depends on the provider.
  • Endpoint: The base URL that AVA uses to connect to your provider's OpenAI-compatible API. Enter the full URL, including any required path prefix, but do not include an individual API endpoint such as /chat/completions or /audio/speech.
  • Model: The exact model identifier accepted by your provider's API. The required format depends on your provider or deployment and can be case-sensitive. For self-hosted models, the identifier might include the model namespace, for example google/Gemma-4-12B-it-qat-w4a16-ct or ornith-ai/Ornith-1.5-397B. You enter the model separately for each AVA feature.

API compatibility requirements

Your provider's OpenAI-compatible API must support the required API endpoints for the AVA features you want to enable:

  • For text generation features, AVA currently uses the Chat Completions API (/chat/completions) but will soon migrate to the Responses API (/responses). We recommend ensuring that your provider supports both APIs for now.
  • For audio generation features, AVA uses the Text-to-Speech API (/audio/speech).

Some OpenAI-compatible APIs or models might not support the reasoning configuration used by AVA, particularly when combined with the AI Assistant's tool-calling functionality. If you encounter compatibility issues, contact our Support team for assistance.

Set up Haiilo AVA

You need the "Manage AVA" permission to manage AVA's settings.

  1. Go to Administration > AVA > Provider.
  2. Select OpenAI-compatible API  as your provider.
  3. Enter the API key and Endpoint from your AI provider.
  4. Select Save changes.

Enable features for AVA

To use AVA's different features, you need to activate each one separately.

  1. Go to Administration > AVA > Features.
  2. Activate the features you want to use AVA for.
  3. Enter the Model you want the feature to use.
  4. Select Save changes.

AVA is now activated and can be used in your platform for the features you enabled.

Was this article helpful?

0 out of 0 found this helpful