Bring Your Own Key (BYOK) for Generative AI Descriptions

If your Oracle Integration instance isn't in a region that supports OCI Generative AI, and you want to use the generative AI description feature, you must subscribe to and register your own AI engine. This is referred to as bring your own key (BYOK).

For information about Oracle Integration's embedded AI capabilities, see AI Innovation and Oracle Integration.

Note:

If you previously registered AI engines in Oracle Integration (before June 2025), you have the following options:
  • If your service instance is in a region mentioned above, you can delete all your AI engine entries.
  • If your service instance isn't in a region mentioned in AI Feature Availability, your registered AI engines will continue to be used to generate AI descriptions. You can still view or delete your entries, but if you want to add or update entries, you must submit a service request.

If you delete all your AI engine entries, the AI engines settings page disappears.

  1. Submit a service request to enable the AI engines settings page.
  2. Subscribe to an AI engine.
  3. In the navigation pane, click Settings, then AI engines.
  4. Click Add to register the AI engine's API key in Oracle Integration.
  5. Enter the following information.
    Element Description
    Name

    Enter a meaningful name.

    Engine
    Select the engine to use.
    • Cohere: This engine supports the command-r-plus model.
    • OpenAPI GPT-4.4.0: This engine supports the gpt-4o model.
    API Key

    Enter the LLM API key you receive when subscribing to the AI engine.

    Based on the LLM API key, the corresponding LLM API (Cohere or OpenAPI) is invoked to generate the integration description.
    Set as default engine

    Click this check box to make the selected engine the default version. Only one engine can be the default.

    After you register your AI engine's API key, you can use the generative AI description feature.

    Note:

    There may be a limitation on the number of API key calls that can be made to the AI engine. When you reach the limit, the key becomes invalid and you receive an unauthorized key error when you attempt to generate a description. Ensure that you review your AI engine subscription documentation for more information about API key capabilities.