Share Folders with the API

The following guide explains how to create an API key in Odeus and share a folder with the API key.

An admin needs to create the API key and share the folder with the API key. Invite an admin as an editor to your folder with the "Share" button in the top right corner (skip this step if you are a Odeus admin yourself).

How to create an API key

1. Navigate to Odeus

   

2. Navigate to the workspace settings.

   

3. Click on "API" under products.

   

4. Create a new API key.

   

5. Enter a name and click "Create API key"

   

6. Copy your API Key to the clipboard.

   

7. Click "Done"

   

8. Leave the settings by clicking on "Settings" on the top left.

   

How to share a folder with the API

1. Open the Library from the left sidebar, or go to Settings → Workspace → Library to manage folders from the admin view.

2. Open the folder you want to share with the API.

3. Click Share.

Steps 4 to 6 are only needed if you are not a Odeus admin. If you are a Odeus admin, you can jump to step 7.

4. Click the Add people and groups field.

5. Type the name of an admin and select them in the dropdown.

6. Select Editor to give them Editor permissions for this folder, then click Share.

7. Ask the admin to open the folder's Share dialog.

8. In the Add people and groups field, search for the API key and select it.

9. Select the API access role. Choose User for search access or Editor for upload and management access.

10. Click Share.

Odeus intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.