About This Task

You can choose the permissions for the API key you're creating: its role and workspaces it can access.

Prerequisites

Learn about available roles and their permissions to choose the right one for your key. Check Managing Access.

Generate an API Key

In deepset AI Platform

1. Click your profile icon in the top right corner and select API Keys.

   

2. One the API Keys page, click Create API Key.

3. Configure the key:

   1. Give it a name. This is optional, if you don't type any name, the key ID is used.
   2. Set the expiration date.
   3. Assign a role to the key.
   4. Choose the workspaces this key can access. If you don't choose any, it will have access to all workspaces in the organization.

4. Click Create API Key.

5. Important: Copy and save your key; after you add it to deepset AI Platform, it remains masked.

6. Click Done.

Using REST API

Use the Create Token API endpoint to create your API keys.