Skip to main content
Version: v1.5.4

APIs

Create an API Key​

Overview​

You can create an application programming interface (API) key to obtain programmatic access to your Enterprise h2oGPTe account.

Instructions​

The following steps describe how to create an API Key:

  1. On Enterprise h2oGPTe, click Account Circle.
  2. Select Using the API.
  3. Click + New API Key. New API Key
  4. (Optional) In the Key name box, enter a name for the API Key.
  5. (Optional) In the Restrict to collection list, select a Collection.
    note

    Specifying a Collection enables you to create a Collection-specific API Key by indicating the Collection you want to link it with. For more information, see Types of API keys.

  6. Click Generate new key.
    caution

    Do not share your API Key with others or expose it within the browser or other client-side code.

info

Refer to the Python Client guide for detailed instructions on how to utilize your API Key with the Enterprise h2oGPTe Python client.

Delete an API Key​

Overview​

Once an API Key is no longer in use, you can delete it.

caution

Deleting an API Key removes the API Key from the servers permanently. Once an API Key is deleted, there is no way to undo the action or recover the deleted API Key.

Instructions​

To delete an API Key, consider the following steps:

  1. On Enterprise h2oGPTe, click Account Circle.
  2. Select Using the API.
  3. In the API Keys table, locate the checkbox corresponding to the API Key you wish to delete, then select it.
  4. Click Delete. Delete API Key
  5. In the Are you sure? card, click Delete.

Types of API Keys​

In Enterprise h2oGPTe there are two types of API Keys:

Global API Keys​

If a Collection is not specified when creating a new API Key, that key is considered to be a global API Key. Use global API Keys to grant full user impersonation and system-wide access to all of your work. Anyone with access to one of your global API Keys can create, delete, or interact with any of your past, current, and future Collections, Documents, Chats, and settings.

Collection-specific API Keys​

Use Collection-specific API Keys to grant external access to only Chat with a specified Collection and make related API calls to it. Collection-specific API keys do not allow other API calls, such as creation, deletion, or access to other Collections or Chats.

Feedback