Using your own keys for tools

Run Tool Store tools, such as image generation, on your organization's own vendor key, and change the key later.

Last updated About 14 hours ago

Some tools of the Tool Store, such as image generation tools, can run on your organization's own account with the tool vendor. You enter your own API key, and the vendor bills your organization directly. This article shows how to find these tools, how to enter the key and how to change it. It is for tool managers. This feature is part of the Enterprise offer.

A tool manager is a member whose plan allows tool management (the Expert plan by default; your organization's plans may differ). A key shared by the whole organization also needs the organization Admin role.

Find the tools that run on your own key

  1. In the sidebar, open Mates & tools, then Toolbox.
  2. In the Billing mode filter, select Bring your own key.
  3. Open a tool. The Bring your own key tag, with a key icon, shows next to its name.

The other billing modes are Included and Pay as you go.

Enter your key when you install a tool

  1. In the sidebar, open Mates & tools, then Tools Store.
  2. Open the tool, for example a tool of the Image generation category, then click Install.
  3. If the tool needs setup, the Complete required setup dialog opens.
  4. If the dialog offers a Configuration list, pick the setup that uses your own key. The configuration decides the billing mode of the tool.
  5. Fill in the fields of the Organization-level section. These values are "Shared across all members of this organization." A field marked with * is required. Click the eye icon to show the key that you pasted.
  6. Click Install.

If you are not an organization Admin, the dialog shows "Admin-managed credentials are required for this tool. Ask an organization admin to complete the setup."

Change the key later

  1. In the Toolbox, open the menu (⋮) of the tool, then click Edit.
  2. The Edit tool instance: {name} dialog opens on its Settings tab.
  3. Replace the key in its field, then click Save.

The saved key shows masked. Click the eye icon to show it.

Keys that each member enters

A field can also be Member-level: "Each member of the organization saves their own value." The install never asks for these fields. Each member fills them in the first time a Mate needs the tool:

  1. The Mate replies: "{toolName} needs credentials before I can run it. Fill in the fields below, then retry the request."
  2. The member fills in the form, marked Required by this tool, and clicks Save credentials.
  3. The member clicks Retry request.

Each member finds their saved keys in their account, under Connections, with the type Tool credentials. See "Personal and shared tool authentication".

Good to know

  • If the organization key is missing, the Mate replies: "{toolName} needs admin-managed credentials before I can run it." Ask an organization admin to enter it from the tool settings.
  • On a Pay as you go tool, the Settings tab shows "This tool is billed per usage."
  • The Tools Store does not show the billing mode of a tool. After the install, check the tag in the Toolbox.