About This Task

When creating an API key, you can set its permissions by choosing a role it should have. You can also choose the type of API key: personal or service.

• Personal keys are linked to the user who created them. Use this type for testing or personal projects.
  Note: These keys become invalid if the user is removed from the organization where the key was created. If a personal key is being used like a service key, update it to a service key instead.
• Service keys are not linked to a specific user. Instead of a username, the search history will show the key name as the actor. Use this type for production applications and systems that connect to the deepset AI Platform.

Scope

You can generate API key for either the workspace or organization:

• Keys generated for a workspace grant access only to this specific workspace.
• Keys generated for an organization grant access to all workspaces in the organization.

Prerequisites

Learn about available roles and their permissions to choose the right one for your key. Check User Roles and Permissions.

Generate an API Key

For a Workspace

1. Click your profile icon in the top right corner and choose Settings.
2. Go to Workspace>API Keys.
3. Click Create API Key:
   1. Choose if it's a personal or a service key.
      Tip: Choose the Service type for production use cases and systems that connect to deepset.
   2. Give your key a name. This is optional, if you don't type any name, the key ID is used.
   3. Set the expiration date.
   4. Choose the role to determine the key's permissions.
4. Click Create API Key.
5. Important: Copy and save your key. After you add it to deepset AI Platform, it remains masked.

For an Organization

1. Click your profile icon in the top right corner and choose Settings.
2. Go to Organization>API Keys.
3. Click Create API Key:
   1. Choose if it's a personal or a service key.
      Tip: Choose the Service type for production use cases and systems that connect to deepset.
   2. Give your key a name. This is optional, if you don't type any name, the key ID is used.
   3. Set the expiration date.
   4. Choose the workspaces this key can access.
   5. Choose the role to determine the key's permissions.
4. Click Create API Key.
5. Important: Copy and save your key. After you add it to deepset AI Platform, it remains masked.