Skip to content
Browse the docs Provider: using your own AI key

Provider: using your own AI key

Provider lets you connect your own account with an AI company, such as OpenAI. Your experts can then answer using models that run on your account. The AI company bills you directly, and those chats are not taken out of your Aimy plan's allowance.

It needs the Professional plan, and only a company admin can use it. On Business, the Provider row is greyed out and the page offers an upgrade. See Plans.

Not the same as the REST API

The key described here comes from an AI company, and Aimy uses it on your behalf. If you want your own software to call Aimy, that is a different key. See REST API.

Before you start

You need an API key from the AI company, copied from their website. Each row in the list names the page where you can get one. The provider must accept requests in the common format that OpenAI uses. Providers that do not are shown as Coming soon and cannot be connected yet.

Connect a provider

  1. Go to Provider under CONNECT. The list shows each provider with its Status, Endpoint, the end of your API key, and how many Models you have switched on. A line above the table says how many providers are connected. Use Search providers to find one.
  2. Choose Connect on the provider's row, or click the row.
  3. Check the Endpoint. It is filled in for you.
  4. Paste your API key.
  5. Choose Connect & test. Aimy checks the key with the provider and fetches the models it can use. A message tells you how many it found.

The row then shows Connected, and the button reads Manage.

Choose the models

After a successful test, a Models section opens in the same window. It shows how many models are enabled out of how many are available.

  1. Tick the models you want your experts to be able to use. Search models, Select all and Clear all help when the list is long.
  2. Choose Save model selection.

A provider that is not in the list

If your provider accepts requests in the OpenAI format but is not listed, choose Add custom provider. Give it a Provider name, the Endpoint address, which is required, and your API key, then choose Connect & test. It joins the list marked as custom.

Use the models in an expert

Models you enabled appear in an expert's model list, grouped under the provider's name, next to the models Aimy provides. Pick one the same way you pick any model. See AI models. An expert on one of your models answers through your key.

Usage keeps these chats apart. They show as expert chat on your own key, and they do not count toward your plan's allowance.

Replace, check or remove a key

Choose Manage on a connected provider.

  • To change the key, paste the new one and choose Replace & test.
  • To look at the key you saved, choose the eye button beside it. Each time someone does this, it is recorded in the audit log as Provider key revealed.
  • To stop using the provider, choose Remove key and confirm. Chats that were using it go back to the models Aimy provides.

How the key is kept

Your key is stored encrypted. It is decrypted only at the moment Aimy sends a request to the provider for you, and the list shows only the last few characters. Only a company admin can reveal it. Deleting the key removes it from Aimy.

What it costs

The provider charges you for every request made with your key, at their own prices. That is separate from your Aimy plan, so keep an eye on your spending in the provider's own dashboard.