Add your own OpenAI model (in preview)

You can connect your own OpenAI account and add your own OpenAI models to Collibra’s registry to have more control over where your requests are processed and what they cost. Once you assign a model to an effort tier, your model is used to run the associated Collibra Maestro tasks.

Prerequisites

  • An OpenAI API key with least-privilege access to the models you want to use. Do not use a personal key.
  • The OpenAI endpoint URL for your region. The default is https://api.openai.com/v1.
  • Optionally, the ID of the OpenAI organization you want to scope requests to.

Steps

  1. Go to Settings → Maestro, then select the Models tab.
  2. Under Available models, click Add model.
  3. On the Connection step, do one of the following:
    • To use an existing connection, select the connection you want to host this model.
    • To create a new connection, click Add connection and complete the following:
      1. Provider: Select OpenAI.
      2. Connection name: Use a clear name your admins will recognize later, such as a project or business unit.
      3. Endpoint URL: The OpenAI connection endpoint. The default is https://api.openai.com/v1. For other regions, see the OpenAI regions documentation.
      4. API key: Your OpenAI API key.
      5. Organization ID: Optional, the ID of the OpenAI organization you want Collibra to send requests to. Provide this if your API key can access more than one OpenAI organization.
      6. Click Next.
      7. On the Test step, click Test.
        Collibra sends a short prompt to confirm it can authenticate and get a reply.
      8. Click Add.
        The new connection is selected as the host for this model.
  4. Click Next.
  5. On the Model step:
    1. In Name, enter a friendly name for this model configuration.
    2. In Provider model, select the OpenAI model you want to add.
  6. Click Next.
  7. Optionally, on the Assign model step, you can either assign the model to a tier, or skip for now:
    1. To assign the model to a tier, select one or more tiers to power with this model. Click Assign model to save the model and assign the tiers you selected. If you don’t select a tier, your model is added to Collibra’s registry, but it isn’t in use.
    2. Otherwise, click Skip for now to save the model without assigning it to a tier.
      The model appears in the Available models table. If you assigned it to a tier, that tier's features start using the model immediately.
  8. If you skipped tier assignment, in the Available models table, click the More icon three dots on the model’s row to assign this model to a tier at any time.

Note Use a dedicated API key with least privilege, not a personal key. The details you enter must match what your key can reach, or the test fails.

What's next

Ensure the models assigned to the effort tiers have a healthy connection. If you see a model with a Model unreachable or Provider unreachable status, update your credentials or model access, or assign a different model to the tier, to resolve the error. Otherwise, requests for that tier return an error.