Generate an API Key

Generate an API key to easily connect deepset Cloud to your solution. You'll need it to use API endpoints or when working in an SDK.

πŸ“˜

You must be an Admin user to perform this task.

An API key gives access to the whole organization (all workspaces within it). It inherits the permissions of the user that created the key.

  1. Click your initials in the top right corner and select Connections.

    The settings menu expanded with the connections option higlighted
  2. Under API Keys, click Add new key.

  3. Select the expiration date for your key and click Generate key.

  4. Important: Copy and save your key, as after you add it to deepset Cloud, it remains hidden.

  5. Click Done.

  6. Use the key to connect the search API endpoint with your application.